/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: 2019-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
42
45
      <holder>Teddy Hogeborn</holder>
43
46
      <holder>Björn Påhlsson</holder>
44
47
    </copyright>
358
361
      start a TLS protocol handshake with a slight quirk: the Mandos
359
362
      server program acts as a TLS <quote>client</quote> while the
360
363
      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.
 
364
      The Mandos client must supply a TLS public key, and the key ID
 
365
      of this public key is used by the Mandos server to look up (in a
 
366
      list read from <filename>clients.conf</filename> at start time)
 
367
      which binary blob to give the client.  No other authentication
 
368
      or authorization is done by the server.
366
369
    </para>
367
370
    <table>
368
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
388
391
        </emphasis></entry>
389
392
      </row>
390
393
      <row>
391
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
392
395
        <entry>-><!-- &rarr; --></entry>
393
396
      </row>
394
397
      <row>
541
544
        </listitem>
542
545
      </varlistentry>
543
546
      <varlistentry>
544
 
        <term><filename class="devicefile">/dev/log</filename></term>
545
 
      </varlistentry>
546
 
      <varlistentry>
547
547
        <term><filename
548
548
        class="directory">/var/lib/mandos</filename></term>
549
549
        <listitem>
555
555
        </listitem>
556
556
      </varlistentry>
557
557
      <varlistentry>
558
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
559
559
        <listitem>
560
560
          <para>
561
561
            The Unix domain socket to where local syslog messages are
586
586
    <para>
587
587
      There is no fine-grained control over logging and debug output.
588
588
    </para>
589
 
    <para>
590
 
      This server does not check the expire time of clients’ OpenPGP
591
 
      keys.
592
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
593
590
  </refsect1>
594
591
  
595
592
  <refsect1 id="example">
645
642
      <title>CLIENTS</title>
646
643
      <para>
647
644
        The server only gives out its stored data to clients which
648
 
        does have the OpenPGP key of the stored fingerprint.  This is
649
 
        guaranteed by the fact that the client sends its OpenPGP
650
 
        public key in the TLS handshake; this ensures it to be
651
 
        genuine.  The server computes the fingerprint of the key
652
 
        itself and looks up the fingerprint in its list of
653
 
        clients. The <filename>clients.conf</filename> file (see
 
645
        does have the correct key ID of the stored key ID.  This is
 
646
        guaranteed by the fact that the client sends its public key in
 
647
        the TLS handshake; this ensures it to be genuine.  The server
 
648
        computes the key ID of the key itself and looks up the key ID
 
649
        in its list of clients. The <filename>clients.conf</filename>
 
650
        file (see
654
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
652
        <manvolnum>5</manvolnum></citerefentry>)
656
653
        <emphasis>must</emphasis> be made non-readable by anyone
708
705
      </varlistentry>
709
706
      <varlistentry>
710
707
        <term>
711
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
712
709
        </term>
713
710
      <listitem>
714
711
        <para>
715
712
          GnuTLS is the library this server uses to implement TLS for
716
713
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
718
715
        </para>
719
716
      </listitem>
720
717
      </varlistentry>
773
770
      </varlistentry>
774
771
      <varlistentry>
775
772
        <term>
 
773
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
774
          Layer Security (TLS) and Datagram Transport Layer Security
 
775
          (DTLS)</citetitle>
 
776
        </term>
 
777
      <listitem>
 
778
        <para>
 
779
          This is implemented by GnuTLS version 3.6.6 and is, if
 
780
          present, used by this server so that raw public keys can be
 
781
          used.
 
782
        </para>
 
783
      </listitem>
 
784
      </varlistentry>
 
785
      <varlistentry>
 
786
        <term>
776
787
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
788
          Security (TLS) Authentication</citetitle>
778
789
        </term>
779
790
      <listitem>
780
791
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          that OpenPGP keys can be used.
 
792
          This is implemented by GnuTLS before version 3.6.0 and is,
 
793
          if present, used by this server so that OpenPGP keys can be
 
794
          used.
783
795
        </para>
784
796
      </listitem>
785
797
      </varlistentry>