/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: 2019-07-25 22:44:36 UTC
  • Revision ID: teddy@recompile.se-20190725224436-19eyd06r7qmtowo6
Allow line breaks on long lines in plugin-runner manual

* debian/mandos-client.lintian-overrides
  (manpage-has-errors-from-man): Remove.
* plugin-runner.xml (EXAMPLE): Allow line breaks by adding ZERO WIDTH
                               SPACE characters.  Also correct
                               description of example command line.

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-11-26">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
38
46
      <holder>Teddy Hogeborn</holder>
39
47
      <holder>Björn Påhlsson</holder>
40
48
    </copyright>
99
107
      <sbr/>
100
108
      <arg><option>--statedir
101
109
      <replaceable>DIRECTORY</replaceable></option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--socket
 
112
      <replaceable>FD</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
102
117
    </cmdsynopsis>
103
118
    <cmdsynopsis>
104
119
      <command>&COMMANDNAME;</command>
285
300
        <term><option>--no-restore</option></term>
286
301
        <listitem>
287
302
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
303
          <para>
 
304
            See also <xref linkend="persistent_state"/>.
 
305
          </para>
288
306
        </listitem>
289
307
      </varlistentry>
290
308
      
295
313
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
314
        </listitem>
297
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--socket
 
319
        <replaceable>FD</replaceable></option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
 
325
      <varlistentry>
 
326
        <term><option>--foreground</option></term>
 
327
        <listitem>
 
328
          <xi:include href="mandos-options.xml"
 
329
                      xpointer="foreground"/>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      
 
333
      <varlistentry>
 
334
        <term><option>--no-zeroconf</option></term>
 
335
        <listitem>
 
336
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
337
        </listitem>
 
338
      </varlistentry>
 
339
      
298
340
    </variablelist>
299
341
  </refsect1>
300
342
  
320
362
      start a TLS protocol handshake with a slight quirk: the Mandos
321
363
      server program acts as a TLS <quote>client</quote> while the
322
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
323
 
      The Mandos client must supply an OpenPGP certificate, and the
324
 
      fingerprint of this certificate is used by the Mandos server to
325
 
      look up (in a list read from <filename>clients.conf</filename>
326
 
      at start time) which binary blob to give the client.  No other
327
 
      authentication or authorization is done by the server.
 
365
      The Mandos client must supply a TLS public key, and the key ID
 
366
      of this public key is used by the Mandos server to look up (in a
 
367
      list read from <filename>clients.conf</filename> at start time)
 
368
      which binary blob to give the client.  No other authentication
 
369
      or authorization is done by the server.
328
370
    </para>
329
371
    <table>
330
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
350
392
        </emphasis></entry>
351
393
      </row>
352
394
      <row>
353
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
354
396
        <entry>-><!-- &rarr; --></entry>
355
397
      </row>
356
398
      <row>
377
419
      extended timeout, checker program, and interval between checks
378
420
      can be configured both globally and per client; see
379
421
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
422
      <manvolnum>5</manvolnum></citerefentry>.
383
423
    </para>
384
424
  </refsect1>
385
425
  
413
453
    </para>
414
454
  </refsect1>
415
455
  
 
456
  <refsect1 id="persistent_state">
 
457
    <title>PERSISTENT STATE</title>
 
458
    <para>
 
459
      Client settings, initially read from
 
460
      <filename>clients.conf</filename>, are persistent across
 
461
      restarts, and run-time changes will override settings in
 
462
      <filename>clients.conf</filename>.  However, if a setting is
 
463
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
464
      <filename>clients.conf</filename>, this will take precedence.
 
465
    </para>
 
466
  </refsect1>
 
467
  
416
468
  <refsect1 id="dbus_interface">
417
469
    <title>D-BUS INTERFACE</title>
418
470
    <para>
480
532
        </listitem>
481
533
      </varlistentry>
482
534
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
484
536
        <listitem>
485
537
          <para>
486
538
            The file containing the process id of the
487
539
            <command>&COMMANDNAME;</command> process started last.
 
540
            <emphasis >Note:</emphasis> If the <filename
 
541
            class="directory">/run</filename> directory does not
 
542
            exist, <filename>/var/run/mandos.pid</filename> will be
 
543
            used instead.
488
544
          </para>
489
545
        </listitem>
490
546
      </varlistentry>
491
547
      <varlistentry>
492
 
        <term><filename class="devicefile">/dev/log</filename></term>
493
 
      </varlistentry>
494
 
      <varlistentry>
495
548
        <term><filename
496
549
        class="directory">/var/lib/mandos</filename></term>
497
550
        <listitem>
503
556
        </listitem>
504
557
      </varlistentry>
505
558
      <varlistentry>
506
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
507
560
        <listitem>
508
561
          <para>
509
562
            The Unix domain socket to where local syslog messages are
534
587
    <para>
535
588
      There is no fine-grained control over logging and debug output.
536
589
    </para>
537
 
    <para>
538
 
      Debug mode is conflated with running in the foreground.
539
 
    </para>
540
 
    <para>
541
 
      This server does not check the expire time of clients’ OpenPGP
542
 
      keys.
543
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
544
591
  </refsect1>
545
592
  
546
593
  <refsect1 id="example">
596
643
      <title>CLIENTS</title>
597
644
      <para>
598
645
        The server only gives out its stored data to clients which
599
 
        does have the OpenPGP key of the stored fingerprint.  This is
600
 
        guaranteed by the fact that the client sends its OpenPGP
601
 
        public key in the TLS handshake; this ensures it to be
602
 
        genuine.  The server computes the fingerprint of the key
603
 
        itself and looks up the fingerprint in its list of
604
 
        clients. The <filename>clients.conf</filename> file (see
 
646
        does have the correct key ID of the stored key ID.  This is
 
647
        guaranteed by the fact that the client sends its public key in
 
648
        the TLS handshake; this ensures it to be genuine.  The server
 
649
        computes the key ID of the key itself and looks up the key ID
 
650
        in its list of clients. The <filename>clients.conf</filename>
 
651
        file (see
605
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
606
653
        <manvolnum>5</manvolnum></citerefentry>)
607
654
        <emphasis>must</emphasis> be made non-readable by anyone
648
695
      </varlistentry>
649
696
      <varlistentry>
650
697
        <term>
651
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
652
699
        </term>
653
700
      <listitem>
654
701
        <para>
659
706
      </varlistentry>
660
707
      <varlistentry>
661
708
        <term>
662
 
          <ulink url="http://www.gnu.org/software/gnutls/"
663
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
664
710
        </term>
665
711
      <listitem>
666
712
        <para>
667
713
          GnuTLS is the library this server uses to implement TLS for
668
714
          communicating securely with the client, and at the same time
669
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
670
716
        </para>
671
717
      </listitem>
672
718
      </varlistentry>
704
750
      </varlistentry>
705
751
      <varlistentry>
706
752
        <term>
707
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
708
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
709
755
        </term>
710
756
      <listitem>
711
757
        <para>
712
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
713
759
        </para>
714
760
      </listitem>
715
761
      </varlistentry>
725
771
      </varlistentry>
726
772
      <varlistentry>
727
773
        <term>
728
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
729
 
          Security</citetitle>
730
 
        </term>
731
 
      <listitem>
732
 
        <para>
733
 
          This is implemented by GnuTLS and used by this server so
734
 
          that OpenPGP keys can be used.
 
774
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
775
          Layer Security (TLS) and Datagram Transport Layer Security
 
776
          (DTLS)</citetitle>
 
777
        </term>
 
778
      <listitem>
 
779
        <para>
 
780
          This is implemented by GnuTLS version 3.6.6 and is, if
 
781
          present, used by this server so that raw public keys can be
 
782
          used.
 
783
        </para>
 
784
      </listitem>
 
785
      </varlistentry>
 
786
      <varlistentry>
 
787
        <term>
 
788
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
789
          Security (TLS) Authentication</citetitle>
 
790
        </term>
 
791
      <listitem>
 
792
        <para>
 
793
          This is implemented by GnuTLS before version 3.6.0 and is,
 
794
          if present, used by this server so that OpenPGP keys can be
 
795
          used.
735
796
        </para>
736
797
      </listitem>
737
798
      </varlistentry>