/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 "2009-09-10">
 
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>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
36
40
      <holder>Teddy Hogeborn</holder>
37
41
      <holder>Björn Påhlsson</holder>
38
42
    </copyright>
86
90
      <sbr/>
87
91
      <arg><option>--debug</option></arg>
88
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
89
96
      <arg><option>--no-dbus</option></arg>
90
97
      <sbr/>
91
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>
92
111
    </cmdsynopsis>
93
112
    <cmdsynopsis>
94
113
      <command>&COMMANDNAME;</command>
112
131
    <para>
113
132
      <command>&COMMANDNAME;</command> is a server daemon which
114
133
      handles incoming request for passwords for a pre-defined list of
115
 
      client host computers.  The Mandos server uses Zeroconf to
116
 
      announce itself on the local network, and uses TLS to
117
 
      communicate securely with and to authenticate the clients.  The
118
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
 
      link-local addresses, since the clients will probably not have
120
 
      any other addresses configured (see <xref linkend="overview"/>).
121
 
      Any authenticated client is then given the stored pre-encrypted
122
 
      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.
123
144
    </para>
124
145
  </refsect1>
125
146
  
194
215
      </varlistentry>
195
216
      
196
217
      <varlistentry>
 
218
        <term><option>--debuglevel
 
219
        <replaceable>LEVEL</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            Set the debugging log level.
 
223
            <replaceable>LEVEL</replaceable> is a string, one of
 
224
            <quote><literal>CRITICAL</literal></quote>,
 
225
            <quote><literal>ERROR</literal></quote>,
 
226
            <quote><literal>WARNING</literal></quote>,
 
227
            <quote><literal>INFO</literal></quote>, or
 
228
            <quote><literal>DEBUG</literal></quote>, in order of
 
229
            increasing verbosity.  The default level is
 
230
            <quote><literal>WARNING</literal></quote>.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
      
 
235
      <varlistentry>
197
236
        <term><option>--priority <replaceable>
198
237
        PRIORITY</replaceable></option></term>
199
238
        <listitem>
250
289
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
290
        </listitem>
252
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
      
253
334
    </variablelist>
254
335
  </refsect1>
255
336
  
329
410
      for some time, the client is assumed to be compromised and is no
330
411
      longer eligible to receive the encrypted password.  (Manual
331
412
      intervention is required to re-enable a client.)  The timeout,
332
 
      checker program, and interval between checks can be configured
333
 
      both globally and per client; see <citerefentry>
 
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>.
 
417
    </para>
 
418
  </refsect1>
 
419
  
 
420
  <refsect1 id="approval">
 
421
    <title>APPROVAL</title>
 
422
    <para>
 
423
      The server can be configured to require manual approval for a
 
424
      client before it is sent its secret.  The delay to wait for such
 
425
      approval and the default action (approve or deny) can be
 
426
      configured both globally and per client; see <citerefentry>
334
427
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.
336
 
    </para>
 
428
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
429
      will be approved immediately without delay.
 
430
    </para>
 
431
    <para>
 
432
      This can be used to deny a client its secret if not manually
 
433
      approved within a specified time.  It can also be used to make
 
434
      the server delay before giving a client its secret, allowing
 
435
      optional manual denying of this specific client.
 
436
    </para>
 
437
    
337
438
  </refsect1>
338
439
  
339
440
  <refsect1 id="logging">
340
441
    <title>LOGGING</title>
341
442
    <para>
342
443
      The server will send log message with various severity levels to
343
 
      <filename>/dev/log</filename>.  With the
 
444
      <filename class="devicefile">/dev/log</filename>.  With the
344
445
      <option>--debug</option> option, it will log even more messages,
345
446
      and also show them on the console.
346
447
    </para>
347
448
  </refsect1>
348
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
  
349
462
  <refsect1 id="dbus_interface">
350
463
    <title>D-BUS INTERFACE</title>
351
464
    <para>
352
465
      The server will by default provide a D-Bus system bus interface.
353
466
      This interface will only be accessible by the root user or a
354
 
      Mandos-specific user, if such a user exists.
355
 
      <!-- XXX -->
 
467
      Mandos-specific user, if such a user exists.  For documentation
 
468
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
356
469
    </para>
357
470
  </refsect1>
358
471
  
413
526
        </listitem>
414
527
      </varlistentry>
415
528
      <varlistentry>
416
 
        <term><filename>/var/run/mandos.pid</filename></term>
417
 
        <listitem>
418
 
          <para>
419
 
            The file containing the process id of
420
 
            <command>&COMMANDNAME;</command>.
 
529
        <term><filename>/run/mandos.pid</filename></term>
 
530
        <listitem>
 
531
          <para>
 
532
            The file containing the process id of the
 
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.
421
552
          </para>
422
553
        </listitem>
423
554
      </varlistentry>
451
582
      backtrace.  This could be considered a feature.
452
583
    </para>
453
584
    <para>
454
 
      Currently, if a client is declared <quote>invalid</quote> due to
455
 
      having timed out, the server does not record this fact onto
456
 
      permanent storage.  This has some security implications, see
457
 
      <xref linkend="clients"/>.
458
 
    </para>
459
 
    <para>
460
 
      There is currently no way of querying the server of the current
461
 
      status of clients, other than analyzing its <systemitem
462
 
      class="service">syslog</systemitem> output.
463
 
    </para>
464
 
    <para>
465
585
      There is no fine-grained control over logging and debug output.
466
586
    </para>
467
587
    <para>
468
 
      Debug mode is conflated with running in the foreground.
469
 
    </para>
470
 
    <para>
471
 
      The console log messages do not show a time stamp.
472
 
    </para>
473
 
    <para>
474
588
      This server does not check the expire time of clients’ OpenPGP
475
589
      keys.
476
590
    </para>
489
603
    <informalexample>
490
604
      <para>
491
605
        Run the server in debug mode, read configuration files from
492
 
        the <filename>~/mandos</filename> directory, and use the
493
 
        Zeroconf service name <quote>Test</quote> to not collide with
494
 
        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:
495
609
      </para>
496
610
      <para>
497
611
 
546
660
        compromised if they are gone for too long.
547
661
      </para>
548
662
      <para>
549
 
        If a client is compromised, its downtime should be duly noted
550
 
        by the server which would therefore declare the client
551
 
        invalid.  But if the server was ever restarted, it would
552
 
        re-read its client list from its configuration file and again
553
 
        regard all clients therein as valid, and hence eligible to
554
 
        receive their passwords.  Therefore, be careful when
555
 
        restarting servers if it is suspected that a client has, in
556
 
        fact, been compromised by parties who may now be running a
557
 
        fake Mandos client with the keys from the non-encrypted
558
 
        initial <acronym>RAM</acronym> image of the client host.  What
559
 
        should be done in that case (if restarting the server program
560
 
        really is necessary) is to stop the server program, edit the
561
 
        configuration file to omit any suspect clients, and restart
562
 
        the server program.
563
 
      </para>
564
 
      <para>
565
663
        For more details on client-side security, see
566
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
567
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
572
670
  <refsect1 id="see_also">
573
671
    <title>SEE ALSO</title>
574
672
    <para>
575
 
      <citerefentry>
576
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
577
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
 
        <refentrytitle>mandos.conf</refentrytitle>
579
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
 
        <refentrytitle>mandos-client</refentrytitle>
581
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
 
      </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>
584
683
    </para>
585
684
    <variablelist>
586
685
      <varlistentry>
607
706
      </varlistentry>
608
707
      <varlistentry>
609
708
        <term>
610
 
          <ulink url="http://www.gnu.org/software/gnutls/"
611
 
          >GnuTLS</ulink>
 
709
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
612
710
        </term>
613
711
      <listitem>
614
712
        <para>
652
750
      </varlistentry>
653
751
      <varlistentry>
654
752
        <term>
655
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
656
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
657
755
        </term>
658
756
      <listitem>
659
757
        <para>
660
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
661
759
        </para>
662
760
      </listitem>
663
761
      </varlistentry>
673
771
      </varlistentry>
674
772
      <varlistentry>
675
773
        <term>
676
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
677
 
          Security</citetitle>
 
774
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
775
          Security (TLS) Authentication</citetitle>
678
776
        </term>
679
777
      <listitem>
680
778
        <para>