/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 at recompile
  • Date: 2020-04-08 19:15:13 UTC
  • mfrom: (399 release)
  • mto: This revision was merged to the branch mainline in revision 400.
  • Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch

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 "2013-10-26">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
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>
40
46
      <holder>Teddy Hogeborn</holder>
41
47
      <holder>Björn Påhlsson</holder>
42
48
    </copyright>
106
112
      <replaceable>FD</replaceable></option></arg>
107
113
      <sbr/>
108
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
109
117
    </cmdsynopsis>
110
118
    <cmdsynopsis>
111
119
      <command>&COMMANDNAME;</command>
234
242
        <term><option>--priority <replaceable>
235
243
        PRIORITY</replaceable></option></term>
236
244
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
245
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
246
        </listitem>
240
247
      </varlistentry>
241
248
      
323
330
        </listitem>
324
331
      </varlistentry>
325
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
      
326
340
    </variablelist>
327
341
  </refsect1>
328
342
  
348
362
      start a TLS protocol handshake with a slight quirk: the Mandos
349
363
      server program acts as a TLS <quote>client</quote> while the
350
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
351
 
      The Mandos client must supply an OpenPGP certificate, and the
352
 
      fingerprint of this certificate is used by the Mandos server to
353
 
      look up (in a list read from <filename>clients.conf</filename>
354
 
      at start time) which binary blob to give the client.  No other
355
 
      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.
356
370
    </para>
357
371
    <table>
358
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
378
392
        </emphasis></entry>
379
393
      </row>
380
394
      <row>
381
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
382
396
        <entry>-><!-- &rarr; --></entry>
383
397
      </row>
384
398
      <row>
531
545
        </listitem>
532
546
      </varlistentry>
533
547
      <varlistentry>
534
 
        <term><filename class="devicefile">/dev/log</filename></term>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
548
        <term><filename
538
549
        class="directory">/var/lib/mandos</filename></term>
539
550
        <listitem>
545
556
        </listitem>
546
557
      </varlistentry>
547
558
      <varlistentry>
548
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
549
560
        <listitem>
550
561
          <para>
551
562
            The Unix domain socket to where local syslog messages are
576
587
    <para>
577
588
      There is no fine-grained control over logging and debug output.
578
589
    </para>
579
 
    <para>
580
 
      This server does not check the expire time of clients’ OpenPGP
581
 
      keys.
582
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
583
591
  </refsect1>
584
592
  
585
593
  <refsect1 id="example">
635
643
      <title>CLIENTS</title>
636
644
      <para>
637
645
        The server only gives out its stored data to clients which
638
 
        does have the OpenPGP key of the stored fingerprint.  This is
639
 
        guaranteed by the fact that the client sends its OpenPGP
640
 
        public key in the TLS handshake; this ensures it to be
641
 
        genuine.  The server computes the fingerprint of the key
642
 
        itself and looks up the fingerprint in its list of
643
 
        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
644
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
653
        <manvolnum>5</manvolnum></citerefentry>)
646
654
        <emphasis>must</emphasis> be made non-readable by anyone
687
695
      </varlistentry>
688
696
      <varlistentry>
689
697
        <term>
690
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
698
          <ulink url="https://www.avahi.org/">Avahi</ulink>
691
699
        </term>
692
700
      <listitem>
693
701
        <para>
698
706
      </varlistentry>
699
707
      <varlistentry>
700
708
        <term>
701
 
          <ulink url="http://www.gnu.org/software/gnutls/"
702
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
703
710
        </term>
704
711
      <listitem>
705
712
        <para>
706
713
          GnuTLS is the library this server uses to implement TLS for
707
714
          communicating securely with the client, and at the same time
708
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
709
716
        </para>
710
717
      </listitem>
711
718
      </varlistentry>
743
750
      </varlistentry>
744
751
      <varlistentry>
745
752
        <term>
746
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
747
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
748
755
        </term>
749
756
      <listitem>
750
757
        <para>
751
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
752
759
        </para>
753
760
      </listitem>
754
761
      </varlistentry>
764
771
      </varlistentry>
765
772
      <varlistentry>
766
773
        <term>
767
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
768
 
          Security</citetitle>
769
 
        </term>
770
 
      <listitem>
771
 
        <para>
772
 
          This is implemented by GnuTLS and used by this server so
773
 
          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.
774
796
        </para>
775
797
      </listitem>
776
798
      </varlistentry>