/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

  • Committer: Teddy Hogeborn
  • Date: 2015-07-20 03:03:33 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150720030333-203m2aeblypcsfte
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.

The mandos-keygen program in Mandos version 1.6.0 and older generated
2048-bit DSA keys, and when GnuTLS uses these it has trouble
connecting using the Mandos default priority string.  This was
previously fixed in Mandos 1.6.2, but the bug reappeared when using
GnuTLS 3, so the default priority string has to change again; this
time also the Mandos client has to change its default, so now the
server and the client should use the same default priority string:

SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA:+SIGN-DSA-SHA256

* mandos (main/server_defaults): Changed default priority string.
* mandos-options.xml (/section/para[id="priority_compat"]): Removed.
  (/section/para[id="priority"]): Changed default priority string.
* mandos.conf ([DEFAULT]/priority): - '' -
* mandos.conf.xml (OPTIONS/priority): Refer to the id "priority"
                                      instead of "priority_compat".
* mandos.xml (OPTIONS/--priority): - '' -
* plugins.d/mandos-client.c (main): Changed default priority string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
93
96
      <arg><option>--no-dbus</option></arg>
94
97
      <sbr/>
95
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-restore</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--statedir
 
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--no-zeroconf</option></arg>
96
111
    </cmdsynopsis>
97
112
    <cmdsynopsis>
98
113
      <command>&COMMANDNAME;</command>
116
131
    <para>
117
132
      <command>&COMMANDNAME;</command> is a server daemon which
118
133
      handles incoming request for passwords for a pre-defined list of
119
 
      client host computers.  The Mandos server uses Zeroconf to
120
 
      announce itself on the local network, and uses TLS to
121
 
      communicate securely with and to authenticate the clients.  The
122
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
123
 
      link-local addresses, since the clients will probably not have
124
 
      any other addresses configured (see <xref linkend="overview"/>).
125
 
      Any authenticated client is then given the stored pre-encrypted
126
 
      password for that specific client.
 
134
      client host computers. For an introduction, see
 
135
      <citerefentry><refentrytitle>intro</refentrytitle>
 
136
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
137
      uses Zeroconf to announce itself on the local network, and uses
 
138
      TLS to communicate securely with and to authenticate the
 
139
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
140
      use IPv6 link-local addresses, since the clients will probably
 
141
      not have any other addresses configured (see <xref
 
142
      linkend="overview"/>).  Any authenticated client is then given
 
143
      the stored pre-encrypted password for that specific client.
127
144
    </para>
128
145
  </refsect1>
129
146
  
272
289
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
290
        </listitem>
274
291
      </varlistentry>
 
292
      
 
293
      <varlistentry>
 
294
        <term><option>--no-restore</option></term>
 
295
        <listitem>
 
296
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
297
          <para>
 
298
            See also <xref linkend="persistent_state"/>.
 
299
          </para>
 
300
        </listitem>
 
301
      </varlistentry>
 
302
      
 
303
      <varlistentry>
 
304
        <term><option>--statedir
 
305
        <replaceable>DIRECTORY</replaceable></option></term>
 
306
        <listitem>
 
307
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
308
        </listitem>
 
309
      </varlistentry>
 
310
      
 
311
      <varlistentry>
 
312
        <term><option>--socket
 
313
        <replaceable>FD</replaceable></option></term>
 
314
        <listitem>
 
315
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
316
        </listitem>
 
317
      </varlistentry>
 
318
      
 
319
      <varlistentry>
 
320
        <term><option>--foreground</option></term>
 
321
        <listitem>
 
322
          <xi:include href="mandos-options.xml"
 
323
                      xpointer="foreground"/>
 
324
        </listitem>
 
325
      </varlistentry>
 
326
      
 
327
      <varlistentry>
 
328
        <term><option>--no-zeroconf</option></term>
 
329
        <listitem>
 
330
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
331
        </listitem>
 
332
      </varlistentry>
 
333
      
275
334
    </variablelist>
276
335
  </refsect1>
277
336
  
351
410
      for some time, the client is assumed to be compromised and is no
352
411
      longer eligible to receive the encrypted password.  (Manual
353
412
      intervention is required to re-enable a client.)  The timeout,
354
 
      checker program, and interval between checks can be configured
355
 
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
358
 
      receiving its password will also be treated as a successful
359
 
      checker run.
 
413
      extended timeout, checker program, and interval between checks
 
414
      can be configured both globally and per client; see
 
415
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
416
      <manvolnum>5</manvolnum></citerefentry>.
360
417
    </para>
361
418
  </refsect1>
362
419
  
384
441
    <title>LOGGING</title>
385
442
    <para>
386
443
      The server will send log message with various severity levels to
387
 
      <filename>/dev/log</filename>.  With the
 
444
      <filename class="devicefile">/dev/log</filename>.  With the
388
445
      <option>--debug</option> option, it will log even more messages,
389
446
      and also show them on the console.
390
447
    </para>
391
448
  </refsect1>
392
449
  
 
450
  <refsect1 id="persistent_state">
 
451
    <title>PERSISTENT STATE</title>
 
452
    <para>
 
453
      Client settings, initially read from
 
454
      <filename>clients.conf</filename>, are persistent across
 
455
      restarts, and run-time changes will override settings in
 
456
      <filename>clients.conf</filename>.  However, if a setting is
 
457
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
458
      <filename>clients.conf</filename>, this will take precedence.
 
459
    </para>
 
460
  </refsect1>
 
461
  
393
462
  <refsect1 id="dbus_interface">
394
463
    <title>D-BUS INTERFACE</title>
395
464
    <para>
457
526
        </listitem>
458
527
      </varlistentry>
459
528
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
529
        <term><filename>/run/mandos.pid</filename></term>
461
530
        <listitem>
462
531
          <para>
463
532
            The file containing the process id of the
464
533
            <command>&COMMANDNAME;</command> process started last.
 
534
            <emphasis >Note:</emphasis> If the <filename
 
535
            class="directory">/run</filename> directory does not
 
536
            exist, <filename>/var/run/mandos.pid</filename> will be
 
537
            used instead.
 
538
          </para>
 
539
        </listitem>
 
540
      </varlistentry>
 
541
      <varlistentry>
 
542
        <term><filename class="devicefile">/dev/log</filename></term>
 
543
      </varlistentry>
 
544
      <varlistentry>
 
545
        <term><filename
 
546
        class="directory">/var/lib/mandos</filename></term>
 
547
        <listitem>
 
548
          <para>
 
549
            Directory where persistent state will be saved.  Change
 
550
            this with the <option>--statedir</option> option.  See
 
551
            also the <option>--no-restore</option> option.
465
552
          </para>
466
553
        </listitem>
467
554
      </varlistentry>
495
582
      backtrace.  This could be considered a feature.
496
583
    </para>
497
584
    <para>
498
 
      Currently, if a client is disabled due to having timed out, the
499
 
      server does not record this fact onto permanent storage.  This
500
 
      has some security implications, see <xref linkend="clients"/>.
501
 
    </para>
502
 
    <para>
503
585
      There is no fine-grained control over logging and debug output.
504
586
    </para>
505
587
    <para>
506
 
      Debug mode is conflated with running in the foreground.
507
 
    </para>
508
 
    <para>
509
 
      The console log messages do not show a time stamp.
510
 
    </para>
511
 
    <para>
512
588
      This server does not check the expire time of clients’ OpenPGP
513
589
      keys.
514
590
    </para>
527
603
    <informalexample>
528
604
      <para>
529
605
        Run the server in debug mode, read configuration files from
530
 
        the <filename>~/mandos</filename> directory, and use the
531
 
        Zeroconf service name <quote>Test</quote> to not collide with
532
 
        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:
533
609
      </para>
534
610
      <para>
535
611
 
584
660
        compromised if they are gone for too long.
585
661
      </para>
586
662
      <para>
587
 
        If a client is compromised, its downtime should be duly noted
588
 
        by the server which would therefore disable the client.  But
589
 
        if the server was ever restarted, it would re-read its client
590
 
        list from its configuration file and again regard all clients
591
 
        therein as enabled, and hence eligible to receive their
592
 
        passwords.  Therefore, be careful when restarting servers if
593
 
        it is suspected that a client has, in fact, been compromised
594
 
        by parties who may now be running a fake Mandos client with
595
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
596
 
        image of the client host.  What should be done in that case
597
 
        (if restarting the server program really is necessary) is to
598
 
        stop the server program, edit the configuration file to omit
599
 
        any suspect clients, and restart the server program.
600
 
      </para>
601
 
      <para>
602
663
        For more details on client-side security, see
603
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
604
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
609
670
  <refsect1 id="see_also">
610
671
    <title>SEE ALSO</title>
611
672
    <para>
612
 
      <citerefentry>
613
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
614
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
 
        <refentrytitle>mandos.conf</refentrytitle>
616
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
618
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
 
      </citerefentry>
 
673
      <citerefentry><refentrytitle>intro</refentrytitle>
 
674
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
675
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
676
      <manvolnum>5</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
680
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>sh</refentrytitle>
 
682
      <manvolnum>1</manvolnum></citerefentry>
621
683
    </para>
622
684
    <variablelist>
623
685
      <varlistentry>
644
706
      </varlistentry>
645
707
      <varlistentry>
646
708
        <term>
647
 
          <ulink url="http://www.gnu.org/software/gnutls/"
648
 
          >GnuTLS</ulink>
 
709
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
649
710
        </term>
650
711
      <listitem>
651
712
        <para>
689
750
      </varlistentry>
690
751
      <varlistentry>
691
752
        <term>
692
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
694
755
        </term>
695
756
      <listitem>
696
757
        <para>
697
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
698
759
        </para>
699
760
      </listitem>
700
761
      </varlistentry>
710
771
      </varlistentry>
711
772
      <varlistentry>
712
773
        <term>
713
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
714
 
          Security</citetitle>
 
774
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
775
          Security (TLS) Authentication</citetitle>
715
776
        </term>
716
777
      <listitem>
717
778
        <para>