/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

* initramfs-tools-hook: Set DEVICE for network hooks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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
4
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2013-10-20">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
38
      <holder>Teddy Hogeborn</holder>
41
39
      <holder>Björn Påhlsson</holder>
42
40
    </copyright>
96
94
      <arg><option>--no-dbus</option></arg>
97
95
      <sbr/>
98
96
      <arg><option>--no-ipv6</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-restore</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--statedir
103
 
      <replaceable>DIRECTORY</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--socket
106
 
      <replaceable>FD</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--foreground</option></arg>
109
97
    </cmdsynopsis>
110
98
    <cmdsynopsis>
111
99
      <command>&COMMANDNAME;</command>
287
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
288
276
        </listitem>
289
277
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--no-restore</option></term>
293
 
        <listitem>
294
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
295
 
          <para>
296
 
            See also <xref linkend="persistent_state"/>.
297
 
          </para>
298
 
        </listitem>
299
 
      </varlistentry>
300
 
      
301
 
      <varlistentry>
302
 
        <term><option>--statedir
303
 
        <replaceable>DIRECTORY</replaceable></option></term>
304
 
        <listitem>
305
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--socket
311
 
        <replaceable>FD</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--foreground</option></term>
319
 
        <listitem>
320
 
          <xi:include href="mandos-options.xml"
321
 
                      xpointer="foreground"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
325
278
    </variablelist>
326
279
  </refsect1>
327
280
  
404
357
      extended timeout, checker program, and interval between checks
405
358
      can be configured both globally and per client; see
406
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
407
 
      <manvolnum>5</manvolnum></citerefentry>.
 
360
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
361
      receiving its password will also be treated as a successful
 
362
      checker run.
408
363
    </para>
409
364
  </refsect1>
410
365
  
432
387
    <title>LOGGING</title>
433
388
    <para>
434
389
      The server will send log message with various severity levels to
435
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
390
      <filename>/dev/log</filename>.  With the
436
391
      <option>--debug</option> option, it will log even more messages,
437
392
      and also show them on the console.
438
393
    </para>
439
394
  </refsect1>
440
395
  
441
 
  <refsect1 id="persistent_state">
442
 
    <title>PERSISTENT STATE</title>
443
 
    <para>
444
 
      Client settings, initially read from
445
 
      <filename>clients.conf</filename>, are persistent across
446
 
      restarts, and run-time changes will override settings in
447
 
      <filename>clients.conf</filename>.  However, if a setting is
448
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
449
 
      <filename>clients.conf</filename>, this will take precedence.
450
 
    </para>
451
 
  </refsect1>
452
 
  
453
396
  <refsect1 id="dbus_interface">
454
397
    <title>D-BUS INTERFACE</title>
455
398
    <para>
517
460
        </listitem>
518
461
      </varlistentry>
519
462
      <varlistentry>
520
 
        <term><filename>/run/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
521
464
        <listitem>
522
465
          <para>
523
466
            The file containing the process id of the
526
469
        </listitem>
527
470
      </varlistentry>
528
471
      <varlistentry>
529
 
        <term><filename class="devicefile">/dev/log</filename></term>
530
 
      </varlistentry>
531
 
      <varlistentry>
532
 
        <term><filename
533
 
        class="directory">/var/lib/mandos</filename></term>
534
 
        <listitem>
535
 
          <para>
536
 
            Directory where persistent state will be saved.  Change
537
 
            this with the <option>--statedir</option> option.  See
538
 
            also the <option>--no-restore</option> option.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
472
        <term><filename>/dev/log</filename></term>
544
473
        <listitem>
545
474
          <para>
569
498
      backtrace.  This could be considered a feature.
570
499
    </para>
571
500
    <para>
 
501
      Currently, if a client is disabled due to having timed out, the
 
502
      server does not record this fact onto permanent storage.  This
 
503
      has some security implications, see <xref linkend="clients"/>.
 
504
    </para>
 
505
    <para>
572
506
      There is no fine-grained control over logging and debug output.
573
507
    </para>
574
508
    <para>
 
509
      Debug mode is conflated with running in the foreground.
 
510
    </para>
 
511
    <para>
 
512
      The console log messages do not show a time stamp.
 
513
    </para>
 
514
    <para>
575
515
      This server does not check the expire time of clients’ OpenPGP
576
516
      keys.
577
517
    </para>
590
530
    <informalexample>
591
531
      <para>
592
532
        Run the server in debug mode, read configuration files from
593
 
        the <filename class="directory">~/mandos</filename> directory,
594
 
        and use the Zeroconf service name <quote>Test</quote> to not
595
 
        collide with any other official Mandos server on this host:
 
533
        the <filename>~/mandos</filename> directory, and use the
 
534
        Zeroconf service name <quote>Test</quote> to not collide with
 
535
        any other official Mandos server on this host:
596
536
      </para>
597
537
      <para>
598
538
 
647
587
        compromised if they are gone for too long.
648
588
      </para>
649
589
      <para>
 
590
        If a client is compromised, its downtime should be duly noted
 
591
        by the server which would therefore disable the client.  But
 
592
        if the server was ever restarted, it would re-read its client
 
593
        list from its configuration file and again regard all clients
 
594
        therein as enabled, and hence eligible to receive their
 
595
        passwords.  Therefore, be careful when restarting servers if
 
596
        it is suspected that a client has, in fact, been compromised
 
597
        by parties who may now be running a fake Mandos client with
 
598
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
599
        image of the client host.  What should be done in that case
 
600
        (if restarting the server program really is necessary) is to
 
601
        stop the server program, edit the configuration file to omit
 
602
        any suspect clients, and restart the server program.
 
603
      </para>
 
604
      <para>
650
605
        For more details on client-side security, see
651
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
652
607
        <manvolnum>8mandos</manvolnum></citerefentry>.