/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-02 01:56:35 UTC
  • Revision ID: teddy@recompile.se-20190302015635-xgodxd3ivltju7qn
mandos-ctl: Refactor

* mandos-ctl (global tablewords): Refactor into TableOfClients.
  (TableOfClients.tablewords): New overrideable class attribute.

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-10">
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>
 
45
      <year>2019</year>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
100
107
      <sbr/>
101
108
      <arg><option>--statedir
102
109
      <replaceable>DIRECTORY</replaceable></option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--socket
 
112
      <replaceable>FD</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
103
117
    </cmdsynopsis>
104
118
    <cmdsynopsis>
105
119
      <command>&COMMANDNAME;</command>
299
313
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
314
        </listitem>
301
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--socket
 
319
        <replaceable>FD</replaceable></option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
 
325
      <varlistentry>
 
326
        <term><option>--foreground</option></term>
 
327
        <listitem>
 
328
          <xi:include href="mandos-options.xml"
 
329
                      xpointer="foreground"/>
 
330
        </listitem>
 
331
      </varlistentry>
 
332
      
 
333
      <varlistentry>
 
334
        <term><option>--no-zeroconf</option></term>
 
335
        <listitem>
 
336
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
337
        </listitem>
 
338
      </varlistentry>
 
339
      
302
340
    </variablelist>
303
341
  </refsect1>
304
342
  
324
362
      start a TLS protocol handshake with a slight quirk: the Mandos
325
363
      server program acts as a TLS <quote>client</quote> while the
326
364
      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.
 
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.
332
370
    </para>
333
371
    <table>
334
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
354
392
        </emphasis></entry>
355
393
      </row>
356
394
      <row>
357
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
358
396
        <entry>-><!-- &rarr; --></entry>
359
397
      </row>
360
398
      <row>
381
419
      extended timeout, checker program, and interval between checks
382
420
      can be configured both globally and per client; see
383
421
      <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.
 
422
      <manvolnum>5</manvolnum></citerefentry>.
387
423
    </para>
388
424
  </refsect1>
389
425
  
496
532
        </listitem>
497
533
      </varlistentry>
498
534
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
500
536
        <listitem>
501
537
          <para>
502
538
            The file containing the process id of the
503
539
            <command>&COMMANDNAME;</command> process started last.
 
540
            <emphasis >Note:</emphasis> If the <filename
 
541
            class="directory">/run</filename> directory does not
 
542
            exist, <filename>/var/run/mandos.pid</filename> will be
 
543
            used instead.
504
544
          </para>
505
545
        </listitem>
506
546
      </varlistentry>
507
547
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
548
        <term><filename
512
549
        class="directory">/var/lib/mandos</filename></term>
513
550
        <listitem>
519
556
        </listitem>
520
557
      </varlistentry>
521
558
      <varlistentry>
522
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
523
560
        <listitem>
524
561
          <para>
525
562
            The Unix domain socket to where local syslog messages are
550
587
    <para>
551
588
      There is no fine-grained control over logging and debug output.
552
589
    </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>
 
590
    <xi:include href="bugs.xml"/>
560
591
  </refsect1>
561
592
  
562
593
  <refsect1 id="example">
612
643
      <title>CLIENTS</title>
613
644
      <para>
614
645
        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
 
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
621
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
622
653
        <manvolnum>5</manvolnum></citerefentry>)
623
654
        <emphasis>must</emphasis> be made non-readable by anyone
675
706
      </varlistentry>
676
707
      <varlistentry>
677
708
        <term>
678
 
          <ulink url="http://www.gnu.org/software/gnutls/"
679
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
680
710
        </term>
681
711
      <listitem>
682
712
        <para>
683
713
          GnuTLS is the library this server uses to implement TLS for
684
714
          communicating securely with the client, and at the same time
685
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
686
716
        </para>
687
717
      </listitem>
688
718
      </varlistentry>
720
750
      </varlistentry>
721
751
      <varlistentry>
722
752
        <term>
723
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
724
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
725
755
        </term>
726
756
      <listitem>
727
757
        <para>
728
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
729
759
        </para>
730
760
      </listitem>
731
761
      </varlistentry>
741
771
      </varlistentry>
742
772
      <varlistentry>
743
773
        <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.
 
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.
751
796
        </para>
752
797
      </listitem>
753
798
      </varlistentry>