/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:31:44 UTC
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
39
45
      <holder>Teddy Hogeborn</holder>
40
46
      <holder>Björn Påhlsson</holder>
41
47
    </copyright>
100
106
      <sbr/>
101
107
      <arg><option>--statedir
102
108
      <replaceable>DIRECTORY</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--socket
 
111
      <replaceable>FD</replaceable></option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--foreground</option></arg>
 
114
      <sbr/>
 
115
      <arg><option>--no-zeroconf</option></arg>
103
116
    </cmdsynopsis>
104
117
    <cmdsynopsis>
105
118
      <command>&COMMANDNAME;</command>
299
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
313
        </listitem>
301
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--socket
 
318
        <replaceable>FD</replaceable></option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
 
324
      <varlistentry>
 
325
        <term><option>--foreground</option></term>
 
326
        <listitem>
 
327
          <xi:include href="mandos-options.xml"
 
328
                      xpointer="foreground"/>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
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
      
302
339
    </variablelist>
303
340
  </refsect1>
304
341
  
324
361
      start a TLS protocol handshake with a slight quirk: the Mandos
325
362
      server program acts as a TLS <quote>client</quote> while the
326
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
327
 
      The Mandos client must supply an OpenPGP certificate, and the
328
 
      fingerprint of this certificate is used by the Mandos server to
329
 
      look up (in a list read from <filename>clients.conf</filename>
330
 
      at start time) which binary blob to give the client.  No other
331
 
      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.
332
369
    </para>
333
370
    <table>
334
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
354
391
        </emphasis></entry>
355
392
      </row>
356
393
      <row>
357
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
358
395
        <entry>-><!-- &rarr; --></entry>
359
396
      </row>
360
397
      <row>
381
418
      extended timeout, checker program, and interval between checks
382
419
      can be configured both globally and per client; see
383
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
385
 
      receiving its password will also be treated as a successful
386
 
      checker run.
 
421
      <manvolnum>5</manvolnum></citerefentry>.
387
422
    </para>
388
423
  </refsect1>
389
424
  
496
531
        </listitem>
497
532
      </varlistentry>
498
533
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
500
535
        <listitem>
501
536
          <para>
502
537
            The file containing the process id of the
503
538
            <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.
504
543
          </para>
505
544
        </listitem>
506
545
      </varlistentry>
507
546
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
547
        <term><filename
512
548
        class="directory">/var/lib/mandos</filename></term>
513
549
        <listitem>
519
555
        </listitem>
520
556
      </varlistentry>
521
557
      <varlistentry>
522
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
523
559
        <listitem>
524
560
          <para>
525
561
            The Unix domain socket to where local syslog messages are
550
586
    <para>
551
587
      There is no fine-grained control over logging and debug output.
552
588
    </para>
553
 
    <para>
554
 
      Debug mode is conflated with running in the foreground.
555
 
    </para>
556
 
    <para>
557
 
      This server does not check the expire time of clients’ OpenPGP
558
 
      keys.
559
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
560
590
  </refsect1>
561
591
  
562
592
  <refsect1 id="example">
612
642
      <title>CLIENTS</title>
613
643
      <para>
614
644
        The server only gives out its stored data to clients which
615
 
        does have the OpenPGP key of the stored fingerprint.  This is
616
 
        guaranteed by the fact that the client sends its OpenPGP
617
 
        public key in the TLS handshake; this ensures it to be
618
 
        genuine.  The server computes the fingerprint of the key
619
 
        itself and looks up the fingerprint in its list of
620
 
        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
621
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
622
652
        <manvolnum>5</manvolnum></citerefentry>)
623
653
        <emphasis>must</emphasis> be made non-readable by anyone
675
705
      </varlistentry>
676
706
      <varlistentry>
677
707
        <term>
678
 
          <ulink url="http://www.gnu.org/software/gnutls/"
679
 
          >GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
680
709
        </term>
681
710
      <listitem>
682
711
        <para>
683
712
          GnuTLS is the library this server uses to implement TLS for
684
713
          communicating securely with the client, and at the same time
685
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
686
715
        </para>
687
716
      </listitem>
688
717
      </varlistentry>
720
749
      </varlistentry>
721
750
      <varlistentry>
722
751
        <term>
723
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
724
 
          Protocol Version 1.1</citetitle>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
725
754
        </term>
726
755
      <listitem>
727
756
        <para>
728
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
729
758
        </para>
730
759
      </listitem>
731
760
      </varlistentry>
741
770
      </varlistentry>
742
771
      <varlistentry>
743
772
        <term>
744
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
745
 
          Security</citetitle>
746
 
        </term>
747
 
      <listitem>
748
 
        <para>
749
 
          This is implemented by GnuTLS and used by this server so
750
 
          that OpenPGP keys can be used.
 
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.
751
795
        </para>
752
796
      </listitem>
753
797
      </varlistentry>