/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-22 19:46:35 UTC
  • Revision ID: teddy@recompile.se-20131022194635-ll6jyg1snrxwe94o
* TODO

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-20">
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>
329
322
        </listitem>
330
323
      </varlistentry>
331
324
      
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
325
    </variablelist>
340
326
  </refsect1>
341
327
  
361
347
      start a TLS protocol handshake with a slight quirk: the Mandos
362
348
      server program acts as a TLS <quote>client</quote> while the
363
349
      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.
 
350
      The Mandos client must supply an OpenPGP certificate, and the
 
351
      fingerprint of this certificate is used by the Mandos server to
 
352
      look up (in a list read from <filename>clients.conf</filename>
 
353
      at start time) which binary blob to give the client.  No other
 
354
      authentication or authorization is done by the server.
369
355
    </para>
370
356
    <table>
371
357
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
377
        </emphasis></entry>
392
378
      </row>
393
379
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
380
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
381
        <entry>-><!-- &rarr; --></entry>
396
382
      </row>
397
383
      <row>
536
522
          <para>
537
523
            The file containing the process id of the
538
524
            <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
525
          </para>
544
526
        </listitem>
545
527
      </varlistentry>
546
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
547
532
        <term><filename
548
533
        class="directory">/var/lib/mandos</filename></term>
549
534
        <listitem>
555
540
        </listitem>
556
541
      </varlistentry>
557
542
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
543
        <term><filename>/dev/log</filename></term>
559
544
        <listitem>
560
545
          <para>
561
546
            The Unix domain socket to where local syslog messages are
586
571
    <para>
587
572
      There is no fine-grained control over logging and debug output.
588
573
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
574
    <para>
 
575
      This server does not check the expire time of clients’ OpenPGP
 
576
      keys.
 
577
    </para>
590
578
  </refsect1>
591
579
  
592
580
  <refsect1 id="example">
642
630
      <title>CLIENTS</title>
643
631
      <para>
644
632
        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
 
633
        does have the OpenPGP key of the stored fingerprint.  This is
 
634
        guaranteed by the fact that the client sends its OpenPGP
 
635
        public key in the TLS handshake; this ensures it to be
 
636
        genuine.  The server computes the fingerprint of the key
 
637
        itself and looks up the fingerprint in its list of
 
638
        clients. The <filename>clients.conf</filename> file (see
651
639
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
640
        <manvolnum>5</manvolnum></citerefentry>)
653
641
        <emphasis>must</emphasis> be made non-readable by anyone
705
693
      </varlistentry>
706
694
      <varlistentry>
707
695
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
696
          <ulink url="http://www.gnu.org/software/gnutls/"
 
697
          >GnuTLS</ulink>
709
698
        </term>
710
699
      <listitem>
711
700
        <para>
712
701
          GnuTLS is the library this server uses to implement TLS for
713
702
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
703
          confidently get the client’s public OpenPGP key.
715
704
        </para>
716
705
      </listitem>
717
706
      </varlistentry>
749
738
      </varlistentry>
750
739
      <varlistentry>
751
740
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
741
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
742
          Protocol Version 1.1</citetitle>
754
743
        </term>
755
744
      <listitem>
756
745
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
746
          TLS 1.1 is the protocol implemented by GnuTLS.
758
747
        </para>
759
748
      </listitem>
760
749
      </varlistentry>
770
759
      </varlistentry>
771
760
      <varlistentry>
772
761
        <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.
 
762
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
763
          Security</citetitle>
 
764
        </term>
 
765
      <listitem>
 
766
        <para>
 
767
          This is implemented by GnuTLS and used by this server so
 
768
          that OpenPGP keys can be used.
795
769
        </para>
796
770
      </listitem>
797
771
      </varlistentry>