/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-02-24">
 
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/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
89
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>
90
111
    </cmdsynopsis>
91
112
    <cmdsynopsis>
92
113
      <command>&COMMANDNAME;</command>
110
131
    <para>
111
132
      <command>&COMMANDNAME;</command> is a server daemon which
112
133
      handles incoming request for passwords for a pre-defined list of
113
 
      client host computers.  The Mandos server uses Zeroconf to
114
 
      announce itself on the local network, and uses TLS to
115
 
      communicate securely with and to authenticate the clients.  The
116
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
 
      link-local addresses, since the clients will probably not have
118
 
      any other addresses configured (see <xref linkend="overview"/>).
119
 
      Any authenticated client is then given the stored pre-encrypted
120
 
      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.
121
144
    </para>
122
145
  </refsect1>
123
146
  
192
215
      </varlistentry>
193
216
      
194
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>
195
236
        <term><option>--priority <replaceable>
196
237
        PRIORITY</replaceable></option></term>
197
238
        <listitem>
233
274
      </varlistentry>
234
275
      
235
276
      <varlistentry>
 
277
        <term><option>--no-dbus</option></term>
 
278
        <listitem>
 
279
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
280
          <para>
 
281
            See also <xref linkend="dbus_interface"/>.
 
282
          </para>
 
283
        </listitem>
 
284
      </varlistentry>
 
285
      
 
286
      <varlistentry>
236
287
        <term><option>--no-ipv6</option></term>
237
288
        <listitem>
238
289
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
290
        </listitem>
240
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
      
241
334
    </variablelist>
242
335
  </refsect1>
243
336
  
315
408
      The server will, by default, continually check that the clients
316
409
      are still up.  If a client has not been confirmed as being up
317
410
      for some time, the client is assumed to be compromised and is no
318
 
      longer eligible to receive the encrypted password.  The timeout,
319
 
      checker program, and interval between checks can be configured
320
 
      both globally and per client; see <citerefentry>
 
411
      longer eligible to receive the encrypted password.  (Manual
 
412
      intervention is required to re-enable a client.)  The timeout,
 
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>
321
427
      <refentrytitle>mandos-clients.conf</refentrytitle>
322
 
      <manvolnum>5</manvolnum></citerefentry>.
323
 
    </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
    
324
438
  </refsect1>
325
439
  
326
440
  <refsect1 id="logging">
327
441
    <title>LOGGING</title>
328
442
    <para>
329
443
      The server will send log message with various severity levels to
330
 
      <filename>/dev/log</filename>.  With the
 
444
      <filename class="devicefile">/dev/log</filename>.  With the
331
445
      <option>--debug</option> option, it will log even more messages,
332
446
      and also show them on the console.
333
447
    </para>
334
448
  </refsect1>
335
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
  
 
462
  <refsect1 id="dbus_interface">
 
463
    <title>D-BUS INTERFACE</title>
 
464
    <para>
 
465
      The server will by default provide a D-Bus system bus interface.
 
466
      This interface will only be accessible by the root user or a
 
467
      Mandos-specific user, if such a user exists.  For documentation
 
468
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
469
    </para>
 
470
  </refsect1>
 
471
  
336
472
  <refsect1 id="exit_status">
337
473
    <title>EXIT STATUS</title>
338
474
    <para>
390
526
        </listitem>
391
527
      </varlistentry>
392
528
      <varlistentry>
393
 
        <term><filename>/var/run/mandos.pid</filename></term>
394
 
        <listitem>
395
 
          <para>
396
 
            The file containing the process id of
397
 
            <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.
398
552
          </para>
399
553
        </listitem>
400
554
      </varlistentry>
428
582
      backtrace.  This could be considered a feature.
429
583
    </para>
430
584
    <para>
431
 
      Currently, if a client is declared <quote>invalid</quote> due to
432
 
      having timed out, the server does not record this fact onto
433
 
      permanent storage.  This has some security implications, see
434
 
      <xref linkend="clients"/>.
435
 
    </para>
436
 
    <para>
437
 
      There is currently no way of querying the server of the current
438
 
      status of clients, other than analyzing its <systemitem
439
 
      class="service">syslog</systemitem> output.
440
 
    </para>
441
 
    <para>
442
585
      There is no fine-grained control over logging and debug output.
443
586
    </para>
444
587
    <para>
445
 
      Debug mode is conflated with running in the foreground.
446
 
    </para>
447
 
    <para>
448
 
      The console log messages do not show a time stamp.
449
 
    </para>
450
 
    <para>
451
588
      This server does not check the expire time of clients’ OpenPGP
452
589
      keys.
453
590
    </para>
466
603
    <informalexample>
467
604
      <para>
468
605
        Run the server in debug mode, read configuration files from
469
 
        the <filename>~/mandos</filename> directory, and use the
470
 
        Zeroconf service name <quote>Test</quote> to not collide with
471
 
        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:
472
609
      </para>
473
610
      <para>
474
611
 
523
660
        compromised if they are gone for too long.
524
661
      </para>
525
662
      <para>
526
 
        If a client is compromised, its downtime should be duly noted
527
 
        by the server which would therefore declare the client
528
 
        invalid.  But if the server was ever restarted, it would
529
 
        re-read its client list from its configuration file and again
530
 
        regard all clients therein as valid, and hence eligible to
531
 
        receive their passwords.  Therefore, be careful when
532
 
        restarting servers if it is suspected that a client has, in
533
 
        fact, been compromised by parties who may now be running a
534
 
        fake Mandos client with the keys from the non-encrypted
535
 
        initial <acronym>RAM</acronym> image of the client host.  What
536
 
        should be done in that case (if restarting the server program
537
 
        really is necessary) is to stop the server program, edit the
538
 
        configuration file to omit any suspect clients, and restart
539
 
        the server program.
540
 
      </para>
541
 
      <para>
542
663
        For more details on client-side security, see
543
664
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
544
665
        <manvolnum>8mandos</manvolnum></citerefentry>.
549
670
  <refsect1 id="see_also">
550
671
    <title>SEE ALSO</title>
551
672
    <para>
552
 
      <citerefentry>
553
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
554
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
 
        <refentrytitle>mandos.conf</refentrytitle>
556
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
 
        <refentrytitle>mandos-client</refentrytitle>
558
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
560
 
      </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>
561
683
    </para>
562
684
    <variablelist>
563
685
      <varlistentry>
584
706
      </varlistentry>
585
707
      <varlistentry>
586
708
        <term>
587
 
          <ulink url="http://www.gnu.org/software/gnutls/"
588
 
          >GnuTLS</ulink>
 
709
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
589
710
        </term>
590
711
      <listitem>
591
712
        <para>
629
750
      </varlistentry>
630
751
      <varlistentry>
631
752
        <term>
632
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
633
 
          Protocol Version 1.1</citetitle>
 
753
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
754
          Protocol Version 1.2</citetitle>
634
755
        </term>
635
756
      <listitem>
636
757
        <para>
637
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
758
          TLS 1.2 is the protocol implemented by GnuTLS.
638
759
        </para>
639
760
      </listitem>
640
761
      </varlistentry>
650
771
      </varlistentry>
651
772
      <varlistentry>
652
773
        <term>
653
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
654
 
          Security</citetitle>
 
774
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
775
          Security (TLS) Authentication</citetitle>
655
776
        </term>
656
777
      <listitem>
657
778
        <para>