/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 00:26:04 UTC
  • Revision ID: teddy@recompile.se-20190302002604-r9kpfc7n8qllwg62
mandos-ctl (print_clients): Factor out making strings from printing

* mandos-ctl (table_rows_of_clients): New.

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 "2013-10-20">
 
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>
106
112
      <replaceable>FD</replaceable></option></arg>
107
113
      <sbr/>
108
114
      <arg><option>--foreground</option></arg>
 
115
      <sbr/>
 
116
      <arg><option>--no-zeroconf</option></arg>
109
117
    </cmdsynopsis>
110
118
    <cmdsynopsis>
111
119
      <command>&COMMANDNAME;</command>
322
330
        </listitem>
323
331
      </varlistentry>
324
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
      
325
340
    </variablelist>
326
341
  </refsect1>
327
342
  
347
362
      start a TLS protocol handshake with a slight quirk: the Mandos
348
363
      server program acts as a TLS <quote>client</quote> while the
349
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
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.
355
370
    </para>
356
371
    <table>
357
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
377
392
        </emphasis></entry>
378
393
      </row>
379
394
      <row>
380
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
381
396
        <entry>-><!-- &rarr; --></entry>
382
397
      </row>
383
398
      <row>
522
537
          <para>
523
538
            The file containing the process id of the
524
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.
525
544
          </para>
526
545
        </listitem>
527
546
      </varlistentry>
528
547
      <varlistentry>
529
 
        <term><filename class="devicefile">/dev/log</filename></term>
530
 
      </varlistentry>
531
 
      <varlistentry>
532
548
        <term><filename
533
549
        class="directory">/var/lib/mandos</filename></term>
534
550
        <listitem>
540
556
        </listitem>
541
557
      </varlistentry>
542
558
      <varlistentry>
543
 
        <term><filename>/dev/log</filename></term>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
544
560
        <listitem>
545
561
          <para>
546
562
            The Unix domain socket to where local syslog messages are
571
587
    <para>
572
588
      There is no fine-grained control over logging and debug output.
573
589
    </para>
574
 
    <para>
575
 
      This server does not check the expire time of clients’ OpenPGP
576
 
      keys.
577
 
    </para>
 
590
    <xi:include href="bugs.xml"/>
578
591
  </refsect1>
579
592
  
580
593
  <refsect1 id="example">
630
643
      <title>CLIENTS</title>
631
644
      <para>
632
645
        The server only gives out its stored data to clients which
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
 
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
639
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
640
653
        <manvolnum>5</manvolnum></citerefentry>)
641
654
        <emphasis>must</emphasis> be made non-readable by anyone
693
706
      </varlistentry>
694
707
      <varlistentry>
695
708
        <term>
696
 
          <ulink url="http://www.gnu.org/software/gnutls/"
697
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
698
710
        </term>
699
711
      <listitem>
700
712
        <para>
701
713
          GnuTLS is the library this server uses to implement TLS for
702
714
          communicating securely with the client, and at the same time
703
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
704
716
        </para>
705
717
      </listitem>
706
718
      </varlistentry>
738
750
      </varlistentry>
739
751
      <varlistentry>
740
752
        <term>
741
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
742
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
743
755
        </term>
744
756
      <listitem>
745
757
        <para>
746
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
747
759
        </para>
748
760
      </listitem>
749
761
      </varlistentry>
759
771
      </varlistentry>
760
772
      <varlistentry>
761
773
        <term>
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.
 
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.
769
796
        </para>
770
797
      </listitem>
771
798
      </varlistentry>