/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: 2011-11-26 22:22:20 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126222220-1ubwjpb5ugqnrhec
Directory with persistent state can now be changed with the "statedir"
option.  The state directory /var/lib/mandos now gets created on
installation.  Added documentation about "restore" and "statedir"
options.

* Makefile (USER, GROUP, STATEDIR): New.
  (maintainer-clean): Also remove "statedir".
  (run-server): Replaced "--no-restore" with "--statedir=statedir".
  (statedir): New.
  (install-server): Make $(STATEDIR) directory.
* debian/mandos.dirs (var/lib/mandos): Added.
* debian/mandos.postinst: Fix ownership of /var/lib/mandos.
* mandos: New --statedir option.
  (stored_state_path): Not global anymore.
  (stored_state_file): New global.
* mandos.conf: Fix whitespace.
  (restore, statedir): Added.
* mandos.conf.xml (OPTIONS, EXAMPLE): Added "restore" and "statedir".
  mandos.xml (SYNOPSIS, OPTIONS): Added "--statedir".
  (FILES): Added "/var/lib/mandos".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
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>
101
99
      <sbr/>
102
100
      <arg><option>--statedir
103
101
      <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
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
111
102
    </cmdsynopsis>
112
103
    <cmdsynopsis>
113
104
      <command>&COMMANDNAME;</command>
294
285
        <term><option>--no-restore</option></term>
295
286
        <listitem>
296
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
297
 
          <para>
298
 
            See also <xref linkend="persistent_state"/>.
299
 
          </para>
300
288
        </listitem>
301
289
      </varlistentry>
302
290
      
307
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
296
        </listitem>
309
297
      </varlistentry>
310
 
      
311
 
      <varlistentry>
312
 
        <term><option>--socket
313
 
        <replaceable>FD</replaceable></option></term>
314
 
        <listitem>
315
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--foreground</option></term>
321
 
        <listitem>
322
 
          <xi:include href="mandos-options.xml"
323
 
                      xpointer="foreground"/>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--no-zeroconf</option></term>
329
 
        <listitem>
330
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
298
    </variablelist>
335
299
  </refsect1>
336
300
  
413
377
      extended timeout, checker program, and interval between checks
414
378
      can be configured both globally and per client; see
415
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
416
 
      <manvolnum>5</manvolnum></citerefentry>.
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
417
383
    </para>
418
384
  </refsect1>
419
385
  
441
407
    <title>LOGGING</title>
442
408
    <para>
443
409
      The server will send log message with various severity levels to
444
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
410
      <filename>/dev/log</filename>.  With the
445
411
      <option>--debug</option> option, it will log even more messages,
446
412
      and also show them on the console.
447
413
    </para>
448
414
  </refsect1>
449
415
  
450
 
  <refsect1 id="persistent_state">
451
 
    <title>PERSISTENT STATE</title>
452
 
    <para>
453
 
      Client settings, initially read from
454
 
      <filename>clients.conf</filename>, are persistent across
455
 
      restarts, and run-time changes will override settings in
456
 
      <filename>clients.conf</filename>.  However, if a setting is
457
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
 
      <filename>clients.conf</filename>, this will take precedence.
459
 
    </para>
460
 
  </refsect1>
461
 
  
462
416
  <refsect1 id="dbus_interface">
463
417
    <title>D-BUS INTERFACE</title>
464
418
    <para>
526
480
        </listitem>
527
481
      </varlistentry>
528
482
      <varlistentry>
529
 
        <term><filename>/run/mandos.pid</filename></term>
 
483
        <term><filename>/var/run/mandos.pid</filename></term>
530
484
        <listitem>
531
485
          <para>
532
486
            The file containing the process id of the
533
487
            <command>&COMMANDNAME;</command> process started last.
534
 
            <emphasis >Note:</emphasis> If the <filename
535
 
            class="directory">/run</filename> directory does not
536
 
            exist, <filename>/var/run/mandos.pid</filename> will be
537
 
            used instead.
538
488
          </para>
539
489
        </listitem>
540
490
      </varlistentry>
541
491
      <varlistentry>
542
 
        <term><filename class="devicefile">/dev/log</filename></term>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
492
        <term><filename
546
493
        class="directory">/var/lib/mandos</filename></term>
547
494
        <listitem>
585
532
      There is no fine-grained control over logging and debug output.
586
533
    </para>
587
534
    <para>
 
535
      Debug mode is conflated with running in the foreground.
 
536
    </para>
 
537
    <para>
588
538
      This server does not check the expire time of clients’ OpenPGP
589
539
      keys.
590
540
    </para>
706
656
      </varlistentry>
707
657
      <varlistentry>
708
658
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
659
          <ulink url="http://www.gnu.org/software/gnutls/"
 
660
          >GnuTLS</ulink>
710
661
        </term>
711
662
      <listitem>
712
663
        <para>
750
701
      </varlistentry>
751
702
      <varlistentry>
752
703
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
704
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
705
          Protocol Version 1.1</citetitle>
755
706
        </term>
756
707
      <listitem>
757
708
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
709
          TLS 1.1 is the protocol implemented by GnuTLS.
759
710
        </para>
760
711
      </listitem>
761
712
      </varlistentry>
771
722
      </varlistentry>
772
723
      <varlistentry>
773
724
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
725
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
726
          Security</citetitle>
776
727
        </term>
777
728
      <listitem>
778
729
        <para>