/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

  • Committer: Teddy Hogeborn
  • Date: 2012-05-12 19:29:05 UTC
  • Revision ID: teddy@recompile.se-20120512192905-8icx7a55j0o7o70n
* mandos (Client.runtime_expansions): Add "expires" and (bug fix)
                                      "last_approval_request".
  (main): Don't ignore SIGINT.
* mandos-clients.conf.xml (RUNTIME EXPANSION): Added "expires".

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 "2011-08-08">
 
5
<!ENTITY TIMESTAMP "2012-01-15">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
94
95
      <arg><option>--no-dbus</option></arg>
95
96
      <sbr/>
96
97
      <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>
97
103
    </cmdsynopsis>
98
104
    <cmdsynopsis>
99
105
      <command>&COMMANDNAME;</command>
275
281
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
276
282
        </listitem>
277
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-restore</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
278
302
    </variablelist>
279
303
  </refsect1>
280
304
  
357
381
      extended timeout, checker program, and interval between checks
358
382
      can be configured both globally and per client; see
359
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
361
 
      receiving its password will also be treated as a successful
362
 
      checker run.
 
384
      <manvolnum>5</manvolnum></citerefentry>.
363
385
    </para>
364
386
  </refsect1>
365
387
  
387
409
    <title>LOGGING</title>
388
410
    <para>
389
411
      The server will send log message with various severity levels to
390
 
      <filename>/dev/log</filename>.  With the
 
412
      <filename class="devicefile">/dev/log</filename>.  With the
391
413
      <option>--debug</option> option, it will log even more messages,
392
414
      and also show them on the console.
393
415
    </para>
394
416
  </refsect1>
395
417
  
 
418
  <refsect1 id="persistent_state">
 
419
    <title>PERSISTENT STATE</title>
 
420
    <para>
 
421
      Client settings, initially read from
 
422
      <filename>clients.conf</filename>, are persistent across
 
423
      restarts, and run-time changes will override settings in
 
424
      <filename>clients.conf</filename>.  However, if a setting is
 
425
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
426
      <filename>clients.conf</filename>, this will take precedence.
 
427
    </para>
 
428
  </refsect1>
 
429
  
396
430
  <refsect1 id="dbus_interface">
397
431
    <title>D-BUS INTERFACE</title>
398
432
    <para>
469
503
        </listitem>
470
504
      </varlistentry>
471
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
 
509
        <term><filename
 
510
        class="directory">/var/lib/mandos</filename></term>
 
511
        <listitem>
 
512
          <para>
 
513
            Directory where persistent state will be saved.  Change
 
514
            this with the <option>--statedir</option> option.  See
 
515
            also the <option>--no-restore</option> option.
 
516
          </para>
 
517
        </listitem>
 
518
      </varlistentry>
 
519
      <varlistentry>
472
520
        <term><filename>/dev/log</filename></term>
473
521
        <listitem>
474
522
          <para>
498
546
      backtrace.  This could be considered a feature.
499
547
    </para>
500
548
    <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>
506
549
      There is no fine-grained control over logging and debug output.
507
550
    </para>
508
551
    <para>
509
552
      Debug mode is conflated with running in the foreground.
510
553
    </para>
511
554
    <para>
512
 
      The console log messages do not show a time stamp.
513
 
    </para>
514
 
    <para>
515
555
      This server does not check the expire time of clients’ OpenPGP
516
556
      keys.
517
557
    </para>
530
570
    <informalexample>
531
571
      <para>
532
572
        Run the server in debug mode, read configuration files from
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:
 
573
        the <filename class="directory">~/mandos</filename> directory,
 
574
        and use the Zeroconf service name <quote>Test</quote> to not
 
575
        collide with any other official Mandos server on this host:
536
576
      </para>
537
577
      <para>
538
578
 
587
627
        compromised if they are gone for too long.
588
628
      </para>
589
629
      <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>
605
630
        For more details on client-side security, see
606
631
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
607
632
        <manvolnum>8mandos</manvolnum></citerefentry>.