/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

* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
  ClientDBus.timeout, ClientDBus.extended_timeout,
  ClientDBus.interval): Bug fix: Cast to correct D-Bus type.
* mandos-ctl (string_to_delta): Interpret unadorned numbers as
                                milliseconds.

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-10">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
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
 
      <year>2019</year>
46
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
104
96
      <arg><option>--no-ipv6</option></arg>
105
97
      <sbr/>
106
98
      <arg><option>--no-restore</option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--statedir
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>
117
99
    </cmdsynopsis>
118
100
    <cmdsynopsis>
119
101
      <command>&COMMANDNAME;</command>
300
282
        <term><option>--no-restore</option></term>
301
283
        <listitem>
302
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--statedir
311
 
        <replaceable>DIRECTORY</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
 
        </listitem>
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
 
      
 
285
        </listitem>
 
286
      </varlistentry>
340
287
    </variablelist>
341
288
  </refsect1>
342
289
  
362
309
      start a TLS protocol handshake with a slight quirk: the Mandos
363
310
      server program acts as a TLS <quote>client</quote> while the
364
311
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
312
      The Mandos client must supply an OpenPGP certificate, and the
 
313
      fingerprint of this certificate is used by the Mandos server to
 
314
      look up (in a list read from <filename>clients.conf</filename>
 
315
      at start time) which binary blob to give the client.  No other
 
316
      authentication or authorization is done by the server.
370
317
    </para>
371
318
    <table>
372
319
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
339
        </emphasis></entry>
393
340
      </row>
394
341
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
342
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
343
        <entry>-><!-- &rarr; --></entry>
397
344
      </row>
398
345
      <row>
419
366
      extended timeout, checker program, and interval between checks
420
367
      can be configured both globally and per client; see
421
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
423
372
    </para>
424
373
  </refsect1>
425
374
  
453
402
    </para>
454
403
  </refsect1>
455
404
  
456
 
  <refsect1 id="persistent_state">
457
 
    <title>PERSISTENT STATE</title>
458
 
    <para>
459
 
      Client settings, initially read from
460
 
      <filename>clients.conf</filename>, are persistent across
461
 
      restarts, and run-time changes will override settings in
462
 
      <filename>clients.conf</filename>.  However, if a setting is
463
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
464
 
      <filename>clients.conf</filename>, this will take precedence.
465
 
    </para>
466
 
  </refsect1>
467
 
  
468
405
  <refsect1 id="dbus_interface">
469
406
    <title>D-BUS INTERFACE</title>
470
407
    <para>
532
469
        </listitem>
533
470
      </varlistentry>
534
471
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
536
473
        <listitem>
537
474
          <para>
538
475
            The file containing the process id of the
539
476
            <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.
544
 
          </para>
545
 
        </listitem>
546
 
      </varlistentry>
547
 
      <varlistentry>
548
 
        <term><filename
549
 
        class="directory">/var/lib/mandos</filename></term>
550
 
        <listitem>
551
 
          <para>
552
 
            Directory where persistent state will be saved.  Change
553
 
            this with the <option>--statedir</option> option.  See
554
 
            also the <option>--no-restore</option> option.
555
477
          </para>
556
478
        </listitem>
557
479
      </varlistentry>
585
507
      backtrace.  This could be considered a feature.
586
508
    </para>
587
509
    <para>
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
 
513
    </para>
 
514
    <para>
588
515
      There is no fine-grained control over logging and debug output.
589
516
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
517
    <para>
 
518
      Debug mode is conflated with running in the foreground.
 
519
    </para>
 
520
    <para>
 
521
      This server does not check the expire time of clients’ OpenPGP
 
522
      keys.
 
523
    </para>
591
524
  </refsect1>
592
525
  
593
526
  <refsect1 id="example">
603
536
    <informalexample>
604
537
      <para>
605
538
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
539
        the <filename>~/mandos</filename> directory, and use the
 
540
        Zeroconf service name <quote>Test</quote> to not collide with
 
541
        any other official Mandos server on this host:
609
542
      </para>
610
543
      <para>
611
544
 
643
576
      <title>CLIENTS</title>
644
577
      <para>
645
578
        The server only gives out its stored data to clients which
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
 
579
        does have the OpenPGP key of the stored fingerprint.  This is
 
580
        guaranteed by the fact that the client sends its OpenPGP
 
581
        public key in the TLS handshake; this ensures it to be
 
582
        genuine.  The server computes the fingerprint of the key
 
583
        itself and looks up the fingerprint in its list of
 
584
        clients. The <filename>clients.conf</filename> file (see
652
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
586
        <manvolnum>5</manvolnum></citerefentry>)
654
587
        <emphasis>must</emphasis> be made non-readable by anyone
660
593
        compromised if they are gone for too long.
661
594
      </para>
662
595
      <para>
 
596
        If a client is compromised, its downtime should be duly noted
 
597
        by the server which would therefore disable the client.  But
 
598
        if the server was ever restarted, it would re-read its client
 
599
        list from its configuration file and again regard all clients
 
600
        therein as enabled, and hence eligible to receive their
 
601
        passwords.  Therefore, be careful when restarting servers if
 
602
        it is suspected that a client has, in fact, been compromised
 
603
        by parties who may now be running a fake Mandos client with
 
604
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
605
        image of the client host.  What should be done in that case
 
606
        (if restarting the server program really is necessary) is to
 
607
        stop the server program, edit the configuration file to omit
 
608
        any suspect clients, and restart the server program.
 
609
      </para>
 
610
      <para>
663
611
        For more details on client-side security, see
664
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
706
654
      </varlistentry>
707
655
      <varlistentry>
708
656
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
657
          <ulink url="http://www.gnu.org/software/gnutls/"
 
658
          >GnuTLS</ulink>
710
659
        </term>
711
660
      <listitem>
712
661
        <para>
713
662
          GnuTLS is the library this server uses to implement TLS for
714
663
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
664
          confidently get the client’s public OpenPGP key.
716
665
        </para>
717
666
      </listitem>
718
667
      </varlistentry>
750
699
      </varlistentry>
751
700
      <varlistentry>
752
701
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
702
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
703
          Protocol Version 1.1</citetitle>
755
704
        </term>
756
705
      <listitem>
757
706
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
707
          TLS 1.1 is the protocol implemented by GnuTLS.
759
708
        </para>
760
709
      </listitem>
761
710
      </varlistentry>
771
720
      </varlistentry>
772
721
      <varlistentry>
773
722
        <term>
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.
 
723
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
724
          Security</citetitle>
 
725
        </term>
 
726
      <listitem>
 
727
        <para>
 
728
          This is implemented by GnuTLS and used by this server so
 
729
          that OpenPGP keys can be used.
796
730
        </para>
797
731
      </listitem>
798
732
      </varlistentry>