/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-22 09:20:19 UTC
  • Revision ID: teddy@recompile.se-20180222092019-ehyz79hzti9dnk2g
Client bug fix: Don't use leak sanitizer with leaking libraries

* Makefile (plugin-helpers/mandos-client): Remove "-fsanitize=leak"
  from CFLAGS.

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 "2022-04-24">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
44
      <year>2018</year>
45
 
      <year>2019</year>
46
45
      <holder>Teddy Hogeborn</holder>
47
46
      <holder>Björn Påhlsson</holder>
48
47
    </copyright>
136
135
    <title>DESCRIPTION</title>
137
136
    <para>
138
137
      <command>&COMMANDNAME;</command> is a server daemon which
139
 
      handles incoming requests for passwords for a pre-defined list
140
 
      of client host computers. For an introduction, see
 
138
      handles incoming request for passwords for a pre-defined list of
 
139
      client host computers. For an introduction, see
141
140
      <citerefentry><refentrytitle>intro</refentrytitle>
142
141
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
142
      uses Zeroconf to announce itself on the local network, and uses
362
361
      start a TLS protocol handshake with a slight quirk: the Mandos
363
362
      server program acts as a TLS <quote>client</quote> while the
364
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
364
      The Mandos client must supply an OpenPGP certificate, and the
 
365
      fingerprint of this certificate is used by the Mandos server to
 
366
      look up (in a list read from <filename>clients.conf</filename>
 
367
      at start time) which binary blob to give the client.  No other
 
368
      authentication or authorization is done by the server.
370
369
    </para>
371
370
    <table>
372
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
391
        </emphasis></entry>
393
392
      </row>
394
393
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
394
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
395
        <entry>-><!-- &rarr; --></entry>
397
396
      </row>
398
397
      <row>
587
586
    <para>
588
587
      There is no fine-grained control over logging and debug output.
589
588
    </para>
 
589
    <para>
 
590
      This server does not check the expire time of clients’ OpenPGP
 
591
      keys.
 
592
    </para>
590
593
    <xi:include href="bugs.xml"/>
591
594
  </refsect1>
592
595
  
643
646
      <title>CLIENTS</title>
644
647
      <para>
645
648
        The server only gives out its stored data to clients which
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
 
649
        does have the OpenPGP key of the stored fingerprint.  This is
 
650
        guaranteed by the fact that the client sends its OpenPGP
 
651
        public key in the TLS handshake; this ensures it to be
 
652
        genuine.  The server computes the fingerprint of the key
 
653
        itself and looks up the fingerprint in its list of
 
654
        clients. The <filename>clients.conf</filename> file (see
652
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
656
        <manvolnum>5</manvolnum></citerefentry>)
654
657
        <emphasis>must</emphasis> be made non-readable by anyone
695
698
      </varlistentry>
696
699
      <varlistentry>
697
700
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
701
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
702
        </term>
700
703
      <listitem>
701
704
        <para>
712
715
        <para>
713
716
          GnuTLS is the library this server uses to implement TLS for
714
717
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
718
          confidently get the client’s public OpenPGP key.
716
719
        </para>
717
720
      </listitem>
718
721
      </varlistentry>
739
742
            <listitem>
740
743
              <para>
741
744
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
745
                immediately usable since a link-local addresses is
743
746
                automatically assigned to a network interfaces when it
744
747
                is brought up.
745
748
              </para>
771
774
      </varlistentry>
772
775
      <varlistentry>
773
776
        <term>
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
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
778
          Security (TLS) Authentication</citetitle>
790
779
        </term>
791
780
      <listitem>
792
781
        <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.
 
782
          This is implemented by GnuTLS and used by this server so
 
783
          that OpenPGP keys can be used.
796
784
        </para>
797
785
      </listitem>
798
786
      </varlistentry>