/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:24:32 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

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