/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: 2016-02-21 14:24:01 UTC
  • Revision ID: teddy@recompile.se-20160221142401-j7glu6a2hg604d1e
Use AddressSanitizer and UndefinedBehaviorSanitizer.

* Makefile (SANITIZE): New; set to all sanitizing options depending on
                       GCC version.
  (CFLAGS): Added "$(SANITIZE)".

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