/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-08 21:18:49 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150708211849-scisutuofnxumqc7
mandos-client: Add --dh-params FILE option.

* plugins.d/mandos-client.c: Added --dh-params FILE option.
  (init_gnutls_global): New "dhparamsfilename" argument.  All callers
                        changed.  Read and use Diffie-Hellman
                        parameters from it.  Bug fix:  check for error
                        when opening seckeyfile for the second time.
  (init_gnutls_session): Remove unnecessary call to
                         gnutls_dh_set_prime_bits();
  (main): New variable "dh_params_file".
  (main/argp_options): Added "--dh-params" option.
  (main/parse_opt): - '' -
* plugins.d/mandos-client.xml (SYNOPSIS): Add --dh-params option.
  (OPTIONS): Document --dh-params option and document that the
             --dh-bits options is potentially overridden by the
             --dh-params option.

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 "2015-01-25">
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>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
96
98
      <arg><option>--no-ipv6</option></arg>
97
99
      <sbr/>
98
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>
99
111
    </cmdsynopsis>
100
112
    <cmdsynopsis>
101
113
      <command>&COMMANDNAME;</command>
224
236
        <term><option>--priority <replaceable>
225
237
        PRIORITY</replaceable></option></term>
226
238
        <listitem>
227
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
228
241
        </listitem>
229
242
      </varlistentry>
230
243
      
282
295
        <term><option>--no-restore</option></term>
283
296
        <listitem>
284
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
 
301
        </listitem>
 
302
      </varlistentry>
 
303
      
 
304
      <varlistentry>
 
305
        <term><option>--statedir
 
306
        <replaceable>DIRECTORY</replaceable></option></term>
 
307
        <listitem>
 
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--socket
 
314
        <replaceable>FD</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--foreground</option></term>
 
322
        <listitem>
 
323
          <xi:include href="mandos-options.xml"
 
324
                      xpointer="foreground"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--no-zeroconf</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
287
335
    </variablelist>
288
336
  </refsect1>
289
337
  
366
414
      extended timeout, checker program, and interval between checks
367
415
      can be configured both globally and per client; see
368
416
      <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.
 
417
      <manvolnum>5</manvolnum></citerefentry>.
372
418
    </para>
373
419
  </refsect1>
374
420
  
402
448
    </para>
403
449
  </refsect1>
404
450
  
 
451
  <refsect1 id="persistent_state">
 
452
    <title>PERSISTENT STATE</title>
 
453
    <para>
 
454
      Client settings, initially read from
 
455
      <filename>clients.conf</filename>, are persistent across
 
456
      restarts, and run-time changes will override settings in
 
457
      <filename>clients.conf</filename>.  However, if a setting is
 
458
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
459
      <filename>clients.conf</filename>, this will take precedence.
 
460
    </para>
 
461
  </refsect1>
 
462
  
405
463
  <refsect1 id="dbus_interface">
406
464
    <title>D-BUS INTERFACE</title>
407
465
    <para>
469
527
        </listitem>
470
528
      </varlistentry>
471
529
      <varlistentry>
472
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
530
        <term><filename>/run/mandos.pid</filename></term>
473
531
        <listitem>
474
532
          <para>
475
533
            The file containing the process id of the
476
534
            <command>&COMMANDNAME;</command> process started last.
 
535
            <emphasis >Note:</emphasis> If the <filename
 
536
            class="directory">/run</filename> directory does not
 
537
            exist, <filename>/var/run/mandos.pid</filename> will be
 
538
            used instead.
477
539
          </para>
478
540
        </listitem>
479
541
      </varlistentry>
480
542
      <varlistentry>
481
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
 
546
        <term><filename
 
547
        class="directory">/var/lib/mandos</filename></term>
 
548
        <listitem>
 
549
          <para>
 
550
            Directory where persistent state will be saved.  Change
 
551
            this with the <option>--statedir</option> option.  See
 
552
            also the <option>--no-restore</option> option.
 
553
          </para>
 
554
        </listitem>
 
555
      </varlistentry>
 
556
      <varlistentry>
 
557
        <term><filename>/dev/log</filename></term>
482
558
        <listitem>
483
559
          <para>
484
560
            The Unix domain socket to where local syslog messages are
507
583
      backtrace.  This could be considered a feature.
508
584
    </para>
509
585
    <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
586
      There is no fine-grained control over logging and debug output.
516
587
    </para>
517
588
    <para>
518
 
      Debug mode is conflated with running in the foreground.
519
 
    </para>
520
 
    <para>
521
589
      This server does not check the expire time of clients’ OpenPGP
522
590
      keys.
523
591
    </para>
536
604
    <informalexample>
537
605
      <para>
538
606
        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:
 
607
        the <filename class="directory">~/mandos</filename> directory,
 
608
        and use the Zeroconf service name <quote>Test</quote> to not
 
609
        collide with any other official Mandos server on this host:
542
610
      </para>
543
611
      <para>
544
612
 
593
661
        compromised if they are gone for too long.
594
662
      </para>
595
663
      <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
664
        For more details on client-side security, see
612
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
613
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
654
707
      </varlistentry>
655
708
      <varlistentry>
656
709
        <term>
657
 
          <ulink url="http://www.gnu.org/software/gnutls/"
658
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
659
711
        </term>
660
712
      <listitem>
661
713
        <para>
699
751
      </varlistentry>
700
752
      <varlistentry>
701
753
        <term>
702
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
703
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
704
756
        </term>
705
757
      <listitem>
706
758
        <para>
707
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
708
760
        </para>
709
761
      </listitem>
710
762
      </varlistentry>
720
772
      </varlistentry>
721
773
      <varlistentry>
722
774
        <term>
723
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
724
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
725
777
        </term>
726
778
      <listitem>
727
779
        <para>