/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: 2025-06-27 19:56:23 UTC
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

Show diffs side-by-side

added added

removed removed

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