/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: 2018-02-08 10:23:55 UTC
  • Revision ID: teddy@recompile.se-20180208102355-3ent7sf87i9h9kka
Update copyright year to 2018

* DBUS-API: Update copyright year to 2018.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* network-hooks.d/bridge: - '' -
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

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-01-01">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
39
45
      <holder>Teddy Hogeborn</holder>
40
46
      <holder>Björn Påhlsson</holder>
41
47
    </copyright>
100
106
      <sbr/>
101
107
      <arg><option>--statedir
102
108
      <replaceable>DIRECTORY</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--socket
 
111
      <replaceable>FD</replaceable></option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--foreground</option></arg>
 
114
      <sbr/>
 
115
      <arg><option>--no-zeroconf</option></arg>
103
116
    </cmdsynopsis>
104
117
    <cmdsynopsis>
105
118
      <command>&COMMANDNAME;</command>
286
299
        <term><option>--no-restore</option></term>
287
300
        <listitem>
288
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
302
          <para>
 
303
            See also <xref linkend="persistent_state"/>.
 
304
          </para>
289
305
        </listitem>
290
306
      </varlistentry>
291
307
      
296
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
313
        </listitem>
298
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--socket
 
318
        <replaceable>FD</replaceable></option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
 
324
      <varlistentry>
 
325
        <term><option>--foreground</option></term>
 
326
        <listitem>
 
327
          <xi:include href="mandos-options.xml"
 
328
                      xpointer="foreground"/>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
332
      <varlistentry>
 
333
        <term><option>--no-zeroconf</option></term>
 
334
        <listitem>
 
335
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
336
        </listitem>
 
337
      </varlistentry>
 
338
      
299
339
    </variablelist>
300
340
  </refsect1>
301
341
  
378
418
      extended timeout, checker program, and interval between checks
379
419
      can be configured both globally and per client; see
380
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
 
421
      <manvolnum>5</manvolnum></citerefentry>.
384
422
    </para>
385
423
  </refsect1>
386
424
  
414
452
    </para>
415
453
  </refsect1>
416
454
  
 
455
  <refsect1 id="persistent_state">
 
456
    <title>PERSISTENT STATE</title>
 
457
    <para>
 
458
      Client settings, initially read from
 
459
      <filename>clients.conf</filename>, are persistent across
 
460
      restarts, and run-time changes will override settings in
 
461
      <filename>clients.conf</filename>.  However, if a setting is
 
462
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
463
      <filename>clients.conf</filename>, this will take precedence.
 
464
    </para>
 
465
  </refsect1>
 
466
  
417
467
  <refsect1 id="dbus_interface">
418
468
    <title>D-BUS INTERFACE</title>
419
469
    <para>
481
531
        </listitem>
482
532
      </varlistentry>
483
533
      <varlistentry>
484
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
485
535
        <listitem>
486
536
          <para>
487
537
            The file containing the process id of the
488
538
            <command>&COMMANDNAME;</command> process started last.
 
539
            <emphasis >Note:</emphasis> If the <filename
 
540
            class="directory">/run</filename> directory does not
 
541
            exist, <filename>/var/run/mandos.pid</filename> will be
 
542
            used instead.
489
543
          </para>
490
544
        </listitem>
491
545
      </varlistentry>
492
546
      <varlistentry>
493
 
        <term><filename class="devicefile">/dev/log</filename></term>
494
 
      </varlistentry>
495
 
      <varlistentry>
496
547
        <term><filename
497
548
        class="directory">/var/lib/mandos</filename></term>
498
549
        <listitem>
504
555
        </listitem>
505
556
      </varlistentry>
506
557
      <varlistentry>
507
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
508
559
        <listitem>
509
560
          <para>
510
561
            The Unix domain socket to where local syslog messages are
536
587
      There is no fine-grained control over logging and debug output.
537
588
    </para>
538
589
    <para>
539
 
      Debug mode is conflated with running in the foreground.
540
 
    </para>
541
 
    <para>
542
590
      This server does not check the expire time of clients’ OpenPGP
543
591
      keys.
544
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
545
594
  </refsect1>
546
595
  
547
596
  <refsect1 id="example">
660
709
      </varlistentry>
661
710
      <varlistentry>
662
711
        <term>
663
 
          <ulink url="http://www.gnu.org/software/gnutls/"
664
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
665
713
        </term>
666
714
      <listitem>
667
715
        <para>
705
753
      </varlistentry>
706
754
      <varlistentry>
707
755
        <term>
708
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
709
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
710
758
        </term>
711
759
      <listitem>
712
760
        <para>
713
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
714
762
        </para>
715
763
      </listitem>
716
764
      </varlistentry>
726
774
      </varlistentry>
727
775
      <varlistentry>
728
776
        <term>
729
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
730
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
731
779
        </term>
732
780
      <listitem>
733
781
        <para>