/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-03-09 15:47:52 UTC
  • mto: This revision was merged to the branch mainline in revision 1046.
  • Revision ID: teddy@recompile.se-20190309154752-hdp3hcbagkvqx91f
mandos-ctl: Refactor

* mandos-ctl (Command.run): Take additional "mandos_objmgr" parameter.
                            All callers changed.
  (PrintTableCmd.output, DumpJSONCmd.output): Take additional
         "mandos_objmgr" parameter, and "clients" is now a sequence of
         attribute dicts.  All callers changed.

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 "2014-06-15">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
40
46
      <holder>Teddy Hogeborn</holder>
41
47
      <holder>Björn Påhlsson</holder>
42
48
    </copyright>
236
242
        <term><option>--priority <replaceable>
237
243
        PRIORITY</replaceable></option></term>
238
244
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
245
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
246
        </listitem>
242
247
      </varlistentry>
243
248
      
357
362
      start a TLS protocol handshake with a slight quirk: the Mandos
358
363
      server program acts as a TLS <quote>client</quote> while the
359
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
360
 
      The Mandos client must supply an OpenPGP certificate, and the
361
 
      fingerprint of this certificate is used by the Mandos server to
362
 
      look up (in a list read from <filename>clients.conf</filename>
363
 
      at start time) which binary blob to give the client.  No other
364
 
      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.
365
370
    </para>
366
371
    <table>
367
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
387
392
        </emphasis></entry>
388
393
      </row>
389
394
      <row>
390
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
391
396
        <entry>-><!-- &rarr; --></entry>
392
397
      </row>
393
398
      <row>
540
545
        </listitem>
541
546
      </varlistentry>
542
547
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
548
        <term><filename
547
549
        class="directory">/var/lib/mandos</filename></term>
548
550
        <listitem>
554
556
        </listitem>
555
557
      </varlistentry>
556
558
      <varlistentry>
557
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
558
560
        <listitem>
559
561
          <para>
560
562
            The Unix domain socket to where local syslog messages are
585
587
    <para>
586
588
      There is no fine-grained control over logging and debug output.
587
589
    </para>
588
 
    <para>
589
 
      This server does not check the expire time of clients’ OpenPGP
590
 
      keys.
591
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
592
591
  </refsect1>
593
592
  
594
593
  <refsect1 id="example">
644
643
      <title>CLIENTS</title>
645
644
      <para>
646
645
        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
 
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
653
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
654
653
        <manvolnum>5</manvolnum></citerefentry>)
655
654
        <emphasis>must</emphasis> be made non-readable by anyone
707
706
      </varlistentry>
708
707
      <varlistentry>
709
708
        <term>
710
 
          <ulink url="http://www.gnu.org/software/gnutls/"
711
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
712
710
        </term>
713
711
      <listitem>
714
712
        <para>
715
713
          GnuTLS is the library this server uses to implement TLS for
716
714
          communicating securely with the client, and at the same time
717
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
718
716
        </para>
719
717
      </listitem>
720
718
      </varlistentry>
752
750
      </varlistentry>
753
751
      <varlistentry>
754
752
        <term>
755
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
757
755
        </term>
758
756
      <listitem>
759
757
        <para>
760
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
761
759
        </para>
762
760
      </listitem>
763
761
      </varlistentry>
773
771
      </varlistentry>
774
772
      <varlistentry>
775
773
        <term>
776
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security</citetitle>
778
 
        </term>
779
 
      <listitem>
780
 
        <para>
781
 
          This is implemented by GnuTLS and used by this server so
782
 
          that OpenPGP keys can be used.
 
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
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
789
          Security (TLS) Authentication</citetitle>
 
790
        </term>
 
791
      <listitem>
 
792
        <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.
783
796
        </para>
784
797
      </listitem>
785
798
      </varlistentry>