/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-04-22 20:19:28 UTC
  • Revision ID: teddy@recompile.se-20190422201928-7vmdtipp0ddsr86r
mandos-ctl: Add tests for all examples in the manual page

* mandos-ctl (Test_commands_from_options.assert_command_from_args):
  Add "length" and "clients" arguments; use them.
  (Test_commands_from_options.assert_commands_from_args): New.
  (Test_commands_from_options.test_manual_page_example_1): - '' -
  (Test_commands_from_options.test_manual_page_example_2): - '' -
  (Test_commands_from_options.test_manual_page_example_3): - '' -
  (Test_commands_from_options.test_manual_page_example_4): - '' -
  (Test_commands_from_options.test_manual_page_example_5): - '' -

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 "2011-10-22">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
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>
38
46
      <holder>Teddy Hogeborn</holder>
39
47
      <holder>Björn Påhlsson</holder>
40
48
    </copyright>
96
104
      <arg><option>--no-ipv6</option></arg>
97
105
      <sbr/>
98
106
      <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>
99
117
    </cmdsynopsis>
100
118
    <cmdsynopsis>
101
119
      <command>&COMMANDNAME;</command>
282
300
        <term><option>--no-restore</option></term>
283
301
        <listitem>
284
302
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
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
      
287
340
    </variablelist>
288
341
  </refsect1>
289
342
  
309
362
      start a TLS protocol handshake with a slight quirk: the Mandos
310
363
      server program acts as a TLS <quote>client</quote> while the
311
364
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
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.
317
370
    </para>
318
371
    <table>
319
372
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
339
392
        </emphasis></entry>
340
393
      </row>
341
394
      <row>
342
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
395
        <entry>Public key (part of TLS handshake)</entry>
343
396
        <entry>-><!-- &rarr; --></entry>
344
397
      </row>
345
398
      <row>
366
419
      extended timeout, checker program, and interval between checks
367
420
      can be configured both globally and per client; see
368
421
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
 
422
      <manvolnum>5</manvolnum></citerefentry>.
372
423
    </para>
373
424
  </refsect1>
374
425
  
396
447
    <title>LOGGING</title>
397
448
    <para>
398
449
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
450
      <filename class="devicefile">/dev/log</filename>.  With the
400
451
      <option>--debug</option> option, it will log even more messages,
401
452
      and also show them on the console.
402
453
    </para>
403
454
  </refsect1>
404
455
  
 
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
  
405
468
  <refsect1 id="dbus_interface">
406
469
    <title>D-BUS INTERFACE</title>
407
470
    <para>
469
532
        </listitem>
470
533
      </varlistentry>
471
534
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
535
        <term><filename>/run/mandos.pid</filename></term>
473
536
        <listitem>
474
537
          <para>
475
538
            The file containing the process id of the
476
539
            <command>&COMMANDNAME;</command> process started last.
477
 
          </para>
478
 
        </listitem>
479
 
      </varlistentry>
480
 
      <varlistentry>
481
 
        <term><filename>/dev/log</filename></term>
 
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
          </para>
 
556
        </listitem>
 
557
      </varlistentry>
 
558
      <varlistentry>
 
559
        <term><filename class="devicefile">/dev/log</filename></term>
482
560
        <listitem>
483
561
          <para>
484
562
            The Unix domain socket to where local syslog messages are
507
585
      backtrace.  This could be considered a feature.
508
586
    </para>
509
587
    <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>
515
588
      There is no fine-grained control over logging and debug output.
516
589
    </para>
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>
 
590
    <xi:include href="bugs.xml"/>
524
591
  </refsect1>
525
592
  
526
593
  <refsect1 id="example">
536
603
    <informalexample>
537
604
      <para>
538
605
        Run the server in debug mode, read configuration files from
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:
 
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:
542
609
      </para>
543
610
      <para>
544
611
 
576
643
      <title>CLIENTS</title>
577
644
      <para>
578
645
        The server only gives out its stored data to clients which
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
 
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
585
652
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
653
        <manvolnum>5</manvolnum></citerefentry>)
587
654
        <emphasis>must</emphasis> be made non-readable by anyone
593
660
        compromised if they are gone for too long.
594
661
      </para>
595
662
      <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>
611
663
        For more details on client-side security, see
612
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
613
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
654
706
      </varlistentry>
655
707
      <varlistentry>
656
708
        <term>
657
 
          <ulink url="http://www.gnu.org/software/gnutls/"
658
 
          >GnuTLS</ulink>
 
709
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
659
710
        </term>
660
711
      <listitem>
661
712
        <para>
662
713
          GnuTLS is the library this server uses to implement TLS for
663
714
          communicating securely with the client, and at the same time
664
 
          confidently get the client’s public OpenPGP key.
 
715
          confidently get the client’s public key.
665
716
        </para>
666
717
      </listitem>
667
718
      </varlistentry>
699
750
      </varlistentry>
700
751
      <varlistentry>
701
752
        <term>
702
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
703
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
704
755
        </term>
705
756
      <listitem>
706
757
        <para>
707
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
708
759
        </para>
709
760
      </listitem>
710
761
      </varlistentry>
720
771
      </varlistentry>
721
772
      <varlistentry>
722
773
        <term>
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.
 
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.
730
796
        </para>
731
797
      </listitem>
732
798
      </varlistentry>