/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

  • Committer: Teddy Hogeborn
  • Date: 2019-07-25 21:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190725214240-31i9qehf60xb8yu4
Use hexadecimal unicode character references, not decimal

* mandos-options.xml (priority): Use "​" instead of "​"
  to make it slightly more clear that ZERO WIDTH SPACE is intended.

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-05-26">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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>
 
45
      <year>2019</year>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
103
110
      <sbr/>
104
111
      <arg><option>--socket
105
112
      <replaceable>FD</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
106
117
    </cmdsynopsis>
107
118
    <cmdsynopsis>
108
119
      <command>&COMMANDNAME;</command>
311
322
        </listitem>
312
323
      </varlistentry>
313
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
      
314
340
    </variablelist>
315
341
  </refsect1>
316
342
  
336
362
      start a TLS protocol handshake with a slight quirk: the Mandos
337
363
      server program acts as a TLS <quote>client</quote> while the
338
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
339
 
      The Mandos client must supply an OpenPGP certificate, and the
340
 
      fingerprint of this certificate is used by the Mandos server to
341
 
      look up (in a list read from <filename>clients.conf</filename>
342
 
      at start time) which binary blob to give the client.  No other
343
 
      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.
344
370
    </para>
345
371
    <table>
346
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
366
392
        </emphasis></entry>
367
393
      </row>
368
394
      <row>
369
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
370
396
        <entry>-><!-- &rarr; --></entry>
371
397
      </row>
372
398
      <row>
506
532
        </listitem>
507
533
      </varlistentry>
508
534
      <varlistentry>
509
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
510
536
        <listitem>
511
537
          <para>
512
538
            The file containing the process id of the
513
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.
514
544
          </para>
515
545
        </listitem>
516
546
      </varlistentry>
517
547
      <varlistentry>
518
 
        <term><filename class="devicefile">/dev/log</filename></term>
519
 
      </varlistentry>
520
 
      <varlistentry>
521
548
        <term><filename
522
549
        class="directory">/var/lib/mandos</filename></term>
523
550
        <listitem>
529
556
        </listitem>
530
557
      </varlistentry>
531
558
      <varlistentry>
532
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
533
560
        <listitem>
534
561
          <para>
535
562
            The Unix domain socket to where local syslog messages are
560
587
    <para>
561
588
      There is no fine-grained control over logging and debug output.
562
589
    </para>
563
 
    <para>
564
 
      Debug mode is conflated with running in the foreground.
565
 
    </para>
566
 
    <para>
567
 
      This server does not check the expire time of clients’ OpenPGP
568
 
      keys.
569
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
570
591
  </refsect1>
571
592
  
572
593
  <refsect1 id="example">
622
643
      <title>CLIENTS</title>
623
644
      <para>
624
645
        The server only gives out its stored data to clients which
625
 
        does have the OpenPGP key of the stored fingerprint.  This is
626
 
        guaranteed by the fact that the client sends its OpenPGP
627
 
        public key in the TLS handshake; this ensures it to be
628
 
        genuine.  The server computes the fingerprint of the key
629
 
        itself and looks up the fingerprint in its list of
630
 
        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
631
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
632
653
        <manvolnum>5</manvolnum></citerefentry>)
633
654
        <emphasis>must</emphasis> be made non-readable by anyone
674
695
      </varlistentry>
675
696
      <varlistentry>
676
697
        <term>
677
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
678
699
        </term>
679
700
      <listitem>
680
701
        <para>
685
706
      </varlistentry>
686
707
      <varlistentry>
687
708
        <term>
688
 
          <ulink url="http://www.gnu.org/software/gnutls/"
689
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
690
710
        </term>
691
711
      <listitem>
692
712
        <para>
693
713
          GnuTLS is the library this server uses to implement TLS for
694
714
          communicating securely with the client, and at the same time
695
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
696
716
        </para>
697
717
      </listitem>
698
718
      </varlistentry>
730
750
      </varlistentry>
731
751
      <varlistentry>
732
752
        <term>
733
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
734
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
735
755
        </term>
736
756
      <listitem>
737
757
        <para>
738
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
739
759
        </para>
740
760
      </listitem>
741
761
      </varlistentry>
751
771
      </varlistentry>
752
772
      <varlistentry>
753
773
        <term>
754
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
755
 
          Security</citetitle>
756
 
        </term>
757
 
      <listitem>
758
 
        <para>
759
 
          This is implemented by GnuTLS and used by this server so
760
 
          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.
761
796
        </para>
762
797
      </listitem>
763
798
      </varlistentry>