/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

* Makefile (install-client-nokey): Create network hook directory.
* debian/mandos-client.README.Debian: Corrected mail address.

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 "2012-06-17">
 
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
38
      <holder>Teddy Hogeborn</holder>
40
39
      <holder>Björn Påhlsson</holder>
41
40
    </copyright>
95
94
      <arg><option>--no-dbus</option></arg>
96
95
      <sbr/>
97
96
      <arg><option>--no-ipv6</option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--no-restore</option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--statedir
102
 
      <replaceable>DIRECTORY</replaceable></option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--socket
105
 
      <replaceable>FD</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--foreground</option></arg>
108
97
    </cmdsynopsis>
109
98
    <cmdsynopsis>
110
99
      <command>&COMMANDNAME;</command>
286
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
287
276
        </listitem>
288
277
      </varlistentry>
289
 
      
290
 
      <varlistentry>
291
 
        <term><option>--no-restore</option></term>
292
 
        <listitem>
293
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
294
 
          <para>
295
 
            See also <xref linkend="persistent_state"/>.
296
 
          </para>
297
 
        </listitem>
298
 
      </varlistentry>
299
 
      
300
 
      <varlistentry>
301
 
        <term><option>--statedir
302
 
        <replaceable>DIRECTORY</replaceable></option></term>
303
 
        <listitem>
304
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
      
308
 
      <varlistentry>
309
 
        <term><option>--socket
310
 
        <replaceable>FD</replaceable></option></term>
311
 
        <listitem>
312
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--foreground</option></term>
318
 
        <listitem>
319
 
          <xi:include href="mandos-options.xml"
320
 
                      xpointer="foreground"/>
321
 
        </listitem>
322
 
      </varlistentry>
323
 
      
324
278
    </variablelist>
325
279
  </refsect1>
326
280
  
403
357
      extended timeout, checker program, and interval between checks
404
358
      can be configured both globally and per client; see
405
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
406
 
      <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.
407
363
    </para>
408
364
  </refsect1>
409
365
  
431
387
    <title>LOGGING</title>
432
388
    <para>
433
389
      The server will send log message with various severity levels to
434
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
390
      <filename>/dev/log</filename>.  With the
435
391
      <option>--debug</option> option, it will log even more messages,
436
392
      and also show them on the console.
437
393
    </para>
438
394
  </refsect1>
439
395
  
440
 
  <refsect1 id="persistent_state">
441
 
    <title>PERSISTENT STATE</title>
442
 
    <para>
443
 
      Client settings, initially read from
444
 
      <filename>clients.conf</filename>, are persistent across
445
 
      restarts, and run-time changes will override settings in
446
 
      <filename>clients.conf</filename>.  However, if a setting is
447
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
448
 
      <filename>clients.conf</filename>, this will take precedence.
449
 
    </para>
450
 
  </refsect1>
451
 
  
452
396
  <refsect1 id="dbus_interface">
453
397
    <title>D-BUS INTERFACE</title>
454
398
    <para>
525
469
        </listitem>
526
470
      </varlistentry>
527
471
      <varlistentry>
528
 
        <term><filename class="devicefile">/dev/log</filename></term>
529
 
      </varlistentry>
530
 
      <varlistentry>
531
 
        <term><filename
532
 
        class="directory">/var/lib/mandos</filename></term>
533
 
        <listitem>
534
 
          <para>
535
 
            Directory where persistent state will be saved.  Change
536
 
            this with the <option>--statedir</option> option.  See
537
 
            also the <option>--no-restore</option> option.
538
 
          </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
      <varlistentry>
542
472
        <term><filename>/dev/log</filename></term>
543
473
        <listitem>
544
474
          <para>
568
498
      backtrace.  This could be considered a feature.
569
499
    </para>
570
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>
571
506
      There is no fine-grained control over logging and debug output.
572
507
    </para>
573
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>
574
515
      This server does not check the expire time of clients’ OpenPGP
575
516
      keys.
576
517
    </para>
589
530
    <informalexample>
590
531
      <para>
591
532
        Run the server in debug mode, read configuration files from
592
 
        the <filename class="directory">~/mandos</filename> directory,
593
 
        and use the Zeroconf service name <quote>Test</quote> to not
594
 
        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:
595
536
      </para>
596
537
      <para>
597
538
 
646
587
        compromised if they are gone for too long.
647
588
      </para>
648
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>
649
605
        For more details on client-side security, see
650
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
651
607
        <manvolnum>8mandos</manvolnum></citerefentry>.