/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:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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