/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: 2013-10-24 20:25:54 UTC
  • mfrom: (634 trunk)
  • mto: This revision was merged to the branch mainline in revision 635.
  • Revision ID: teddy@recompile.se-20131024202554-nb00jm6khi280lum
Merge from trunk.

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 "2019-02-09">
 
5
<!ENTITY TIMESTAMP "2013-10-23">
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
40
      <holder>Teddy Hogeborn</holder>
46
41
      <holder>Björn Påhlsson</holder>
47
42
    </copyright>
111
106
      <replaceable>FD</replaceable></option></arg>
112
107
      <sbr/>
113
108
      <arg><option>--foreground</option></arg>
114
 
      <sbr/>
115
 
      <arg><option>--no-zeroconf</option></arg>
116
109
    </cmdsynopsis>
117
110
    <cmdsynopsis>
118
111
      <command>&COMMANDNAME;</command>
241
234
        <term><option>--priority <replaceable>
242
235
        PRIORITY</replaceable></option></term>
243
236
        <listitem>
244
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="mandos-options.xml"
 
238
                      xpointer="priority_compat"/>
245
239
        </listitem>
246
240
      </varlistentry>
247
241
      
329
323
        </listitem>
330
324
      </varlistentry>
331
325
      
332
 
      <varlistentry>
333
 
        <term><option>--no-zeroconf</option></term>
334
 
        <listitem>
335
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
      
339
326
    </variablelist>
340
327
  </refsect1>
341
328
  
361
348
      start a TLS protocol handshake with a slight quirk: the Mandos
362
349
      server program acts as a TLS <quote>client</quote> while the
363
350
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
351
      The Mandos client must supply an OpenPGP certificate, and the
 
352
      fingerprint of this certificate is used by the Mandos server to
 
353
      look up (in a list read from <filename>clients.conf</filename>
 
354
      at start time) which binary blob to give the client.  No other
 
355
      authentication or authorization is done by the server.
369
356
    </para>
370
357
    <table>
371
358
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
378
        </emphasis></entry>
392
379
      </row>
393
380
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
381
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
382
        <entry>-><!-- &rarr; --></entry>
396
383
      </row>
397
384
      <row>
536
523
          <para>
537
524
            The file containing the process id of the
538
525
            <command>&COMMANDNAME;</command> process started last.
539
 
            <emphasis >Note:</emphasis> If the <filename
540
 
            class="directory">/run</filename> directory does not
541
 
            exist, <filename>/var/run/mandos.pid</filename> will be
542
 
            used instead.
543
526
          </para>
544
527
        </listitem>
545
528
      </varlistentry>
546
529
      <varlistentry>
 
530
        <term><filename class="devicefile">/dev/log</filename></term>
 
531
      </varlistentry>
 
532
      <varlistentry>
547
533
        <term><filename
548
534
        class="directory">/var/lib/mandos</filename></term>
549
535
        <listitem>
555
541
        </listitem>
556
542
      </varlistentry>
557
543
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
        <term><filename>/dev/log</filename></term>
559
545
        <listitem>
560
546
          <para>
561
547
            The Unix domain socket to where local syslog messages are
586
572
    <para>
587
573
      There is no fine-grained control over logging and debug output.
588
574
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
575
    <para>
 
576
      This server does not check the expire time of clients’ OpenPGP
 
577
      keys.
 
578
    </para>
590
579
  </refsect1>
591
580
  
592
581
  <refsect1 id="example">
642
631
      <title>CLIENTS</title>
643
632
      <para>
644
633
        The server only gives out its stored data to clients which
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
 
634
        does have the OpenPGP key of the stored fingerprint.  This is
 
635
        guaranteed by the fact that the client sends its OpenPGP
 
636
        public key in the TLS handshake; this ensures it to be
 
637
        genuine.  The server computes the fingerprint of the key
 
638
        itself and looks up the fingerprint in its list of
 
639
        clients. The <filename>clients.conf</filename> file (see
651
640
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
641
        <manvolnum>5</manvolnum></citerefentry>)
653
642
        <emphasis>must</emphasis> be made non-readable by anyone
705
694
      </varlistentry>
706
695
      <varlistentry>
707
696
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
697
          <ulink url="http://www.gnu.org/software/gnutls/"
 
698
          >GnuTLS</ulink>
709
699
        </term>
710
700
      <listitem>
711
701
        <para>
712
702
          GnuTLS is the library this server uses to implement TLS for
713
703
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
704
          confidently get the client’s public OpenPGP key.
715
705
        </para>
716
706
      </listitem>
717
707
      </varlistentry>
749
739
      </varlistentry>
750
740
      <varlistentry>
751
741
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
742
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
743
          Protocol Version 1.1</citetitle>
754
744
        </term>
755
745
      <listitem>
756
746
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
747
          TLS 1.1 is the protocol implemented by GnuTLS.
758
748
        </para>
759
749
      </listitem>
760
750
      </varlistentry>
770
760
      </varlistentry>
771
761
      <varlistentry>
772
762
        <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>
787
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
 
          Security (TLS) Authentication</citetitle>
789
 
        </term>
790
 
      <listitem>
791
 
        <para>
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.
 
763
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
764
          Security</citetitle>
 
765
        </term>
 
766
      <listitem>
 
767
        <para>
 
768
          This is implemented by GnuTLS and used by this server so
 
769
          that OpenPGP keys can be used.
795
770
        </para>
796
771
      </listitem>
797
772
      </varlistentry>