/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-06-03 17:27:03 UTC
  • Revision ID: teddy@recompile.se-20160603172703-mc6tjor6rhq4xy74
mandos: Bug fix: Do multiprocessing cleanup correctly on exit

* mandos (main): Save module "multiprocessing" and open file "wnull"
                 as scope variables accessible by function cleanup(),
                 since the module and global variable may not be
                 accessible when the cleanup() function is run as
                 scheduled by atexit().

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