/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

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