/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-02-09 23:36:11 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190209233611-qurtq0kpsoct9uwf
Doc fix: Minor clarification

* mandos-clients.conf.xml (OPTIONS/checker): Be more clear that it's
  specifically an SSH key fingerprint that is being compared, and no
  other kind of fingerprint.

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-02-09">
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>
40
45
      <holder>Teddy Hogeborn</holder>
41
46
      <holder>Björn Påhlsson</holder>
42
47
    </copyright>
106
111
      <replaceable>FD</replaceable></option></arg>
107
112
      <sbr/>
108
113
      <arg><option>--foreground</option></arg>
 
114
      <sbr/>
 
115
      <arg><option>--no-zeroconf</option></arg>
109
116
    </cmdsynopsis>
110
117
    <cmdsynopsis>
111
118
      <command>&COMMANDNAME;</command>
234
241
        <term><option>--priority <replaceable>
235
242
        PRIORITY</replaceable></option></term>
236
243
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
244
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
245
        </listitem>
240
246
      </varlistentry>
241
247
      
323
329
        </listitem>
324
330
      </varlistentry>
325
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
      
326
339
    </variablelist>
327
340
  </refsect1>
328
341
  
348
361
      start a TLS protocol handshake with a slight quirk: the Mandos
349
362
      server program acts as a TLS <quote>client</quote> while the
350
363
      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.
 
364
      The Mandos client must supply a TLS public key, and the key ID
 
365
      of this public key is used by the Mandos server to look up (in a
 
366
      list read from <filename>clients.conf</filename> at start time)
 
367
      which binary blob to give the client.  No other authentication
 
368
      or authorization is done by the server.
356
369
    </para>
357
370
    <table>
358
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
378
391
        </emphasis></entry>
379
392
      </row>
380
393
      <row>
381
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
382
395
        <entry>-><!-- &rarr; --></entry>
383
396
      </row>
384
397
      <row>
531
544
        </listitem>
532
545
      </varlistentry>
533
546
      <varlistentry>
534
 
        <term><filename class="devicefile">/dev/log</filename></term>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
547
        <term><filename
538
548
        class="directory">/var/lib/mandos</filename></term>
539
549
        <listitem>
545
555
        </listitem>
546
556
      </varlistentry>
547
557
      <varlistentry>
548
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
549
559
        <listitem>
550
560
          <para>
551
561
            The Unix domain socket to where local syslog messages are
576
586
    <para>
577
587
      There is no fine-grained control over logging and debug output.
578
588
    </para>
579
 
    <para>
580
 
      This server does not check the expire time of clients’ OpenPGP
581
 
      keys.
582
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
583
590
  </refsect1>
584
591
  
585
592
  <refsect1 id="example">
635
642
      <title>CLIENTS</title>
636
643
      <para>
637
644
        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
 
645
        does have the correct key ID of the stored key ID.  This is
 
646
        guaranteed by the fact that the client sends its public key in
 
647
        the TLS handshake; this ensures it to be genuine.  The server
 
648
        computes the key ID of the key itself and looks up the key ID
 
649
        in its list of clients. The <filename>clients.conf</filename>
 
650
        file (see
644
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
652
        <manvolnum>5</manvolnum></citerefentry>)
646
653
        <emphasis>must</emphasis> be made non-readable by anyone
698
705
      </varlistentry>
699
706
      <varlistentry>
700
707
        <term>
701
 
          <ulink url="http://www.gnu.org/software/gnutls/"
702
 
          >GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
703
709
        </term>
704
710
      <listitem>
705
711
        <para>
706
712
          GnuTLS is the library this server uses to implement TLS for
707
713
          communicating securely with the client, and at the same time
708
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
709
715
        </para>
710
716
      </listitem>
711
717
      </varlistentry>
743
749
      </varlistentry>
744
750
      <varlistentry>
745
751
        <term>
746
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
747
 
          Protocol Version 1.1</citetitle>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
748
754
        </term>
749
755
      <listitem>
750
756
        <para>
751
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
752
758
        </para>
753
759
      </listitem>
754
760
      </varlistentry>
764
770
      </varlistentry>
765
771
      <varlistentry>
766
772
        <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.
 
773
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
774
          Layer Security (TLS) and Datagram Transport Layer Security
 
775
          (DTLS)</citetitle>
 
776
        </term>
 
777
      <listitem>
 
778
        <para>
 
779
          This is implemented by GnuTLS version 3.6.6 and is, if
 
780
          present, used by this server so that raw public keys can be
 
781
          used.
 
782
        </para>
 
783
      </listitem>
 
784
      </varlistentry>
 
785
      <varlistentry>
 
786
        <term>
 
787
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
788
          Security (TLS) Authentication</citetitle>
 
789
        </term>
 
790
      <listitem>
 
791
        <para>
 
792
          This is implemented by GnuTLS before version 3.6.0 and is,
 
793
          if present, used by this server so that OpenPGP keys can be
 
794
          used.
774
795
        </para>
775
796
      </listitem>
776
797
      </varlistentry>