/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

Merge threading/seg fault fix.

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