/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-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>
286
299
        <term><option>--no-restore</option></term>
287
300
        <listitem>
288
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
302
          <para>
 
303
            See also <xref linkend="persistent_state"/>.
 
304
          </para>
289
305
        </listitem>
290
306
      </varlistentry>
291
307
      
296
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
313
        </listitem>
298
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
      
299
339
    </variablelist>
300
340
  </refsect1>
301
341
  
321
361
      start a TLS protocol handshake with a slight quirk: the Mandos
322
362
      server program acts as a TLS <quote>client</quote> while the
323
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
324
 
      The Mandos client must supply an OpenPGP certificate, and the
325
 
      fingerprint of this certificate is used by the Mandos server to
326
 
      look up (in a list read from <filename>clients.conf</filename>
327
 
      at start time) which binary blob to give the client.  No other
328
 
      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.
329
369
    </para>
330
370
    <table>
331
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
351
391
        </emphasis></entry>
352
392
      </row>
353
393
      <row>
354
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
355
395
        <entry>-><!-- &rarr; --></entry>
356
396
      </row>
357
397
      <row>
378
418
      extended timeout, checker program, and interval between checks
379
419
      can be configured both globally and per client; see
380
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
 
421
      <manvolnum>5</manvolnum></citerefentry>.
384
422
    </para>
385
423
  </refsect1>
386
424
  
414
452
    </para>
415
453
  </refsect1>
416
454
  
 
455
  <refsect1 id="persistent_state">
 
456
    <title>PERSISTENT STATE</title>
 
457
    <para>
 
458
      Client settings, initially read from
 
459
      <filename>clients.conf</filename>, are persistent across
 
460
      restarts, and run-time changes will override settings in
 
461
      <filename>clients.conf</filename>.  However, if a setting is
 
462
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
463
      <filename>clients.conf</filename>, this will take precedence.
 
464
    </para>
 
465
  </refsect1>
 
466
  
417
467
  <refsect1 id="dbus_interface">
418
468
    <title>D-BUS INTERFACE</title>
419
469
    <para>
481
531
        </listitem>
482
532
      </varlistentry>
483
533
      <varlistentry>
484
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
485
535
        <listitem>
486
536
          <para>
487
537
            The file containing the process id of the
488
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.
489
543
          </para>
490
544
        </listitem>
491
545
      </varlistentry>
492
546
      <varlistentry>
493
 
        <term><filename class="devicefile">/dev/log</filename></term>
494
 
      </varlistentry>
495
 
      <varlistentry>
496
547
        <term><filename
497
548
        class="directory">/var/lib/mandos</filename></term>
498
549
        <listitem>
504
555
        </listitem>
505
556
      </varlistentry>
506
557
      <varlistentry>
507
 
        <term><filename>/dev/log</filename></term>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
508
559
        <listitem>
509
560
          <para>
510
561
            The Unix domain socket to where local syslog messages are
535
586
    <para>
536
587
      There is no fine-grained control over logging and debug output.
537
588
    </para>
538
 
    <para>
539
 
      Debug mode is conflated with running in the foreground.
540
 
    </para>
541
 
    <para>
542
 
      This server does not check the expire time of clients’ OpenPGP
543
 
      keys.
544
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
545
590
  </refsect1>
546
591
  
547
592
  <refsect1 id="example">
597
642
      <title>CLIENTS</title>
598
643
      <para>
599
644
        The server only gives out its stored data to clients which
600
 
        does have the OpenPGP key of the stored fingerprint.  This is
601
 
        guaranteed by the fact that the client sends its OpenPGP
602
 
        public key in the TLS handshake; this ensures it to be
603
 
        genuine.  The server computes the fingerprint of the key
604
 
        itself and looks up the fingerprint in its list of
605
 
        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
606
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
607
652
        <manvolnum>5</manvolnum></citerefentry>)
608
653
        <emphasis>must</emphasis> be made non-readable by anyone
660
705
      </varlistentry>
661
706
      <varlistentry>
662
707
        <term>
663
 
          <ulink url="http://www.gnu.org/software/gnutls/"
664
 
          >GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
665
709
        </term>
666
710
      <listitem>
667
711
        <para>
668
712
          GnuTLS is the library this server uses to implement TLS for
669
713
          communicating securely with the client, and at the same time
670
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
671
715
        </para>
672
716
      </listitem>
673
717
      </varlistentry>
705
749
      </varlistentry>
706
750
      <varlistentry>
707
751
        <term>
708
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
709
 
          Protocol Version 1.1</citetitle>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
710
754
        </term>
711
755
      <listitem>
712
756
        <para>
713
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
714
758
        </para>
715
759
      </listitem>
716
760
      </varlistentry>
726
770
      </varlistentry>
727
771
      <varlistentry>
728
772
        <term>
729
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
730
 
          Security</citetitle>
731
 
        </term>
732
 
      <listitem>
733
 
        <para>
734
 
          This is implemented by GnuTLS and used by this server so
735
 
          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.
736
795
        </para>
737
796
      </listitem>
738
797
      </varlistentry>