/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-11-26">
 
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>
99
101
      <sbr/>
100
102
      <arg><option>--statedir
101
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>
102
111
    </cmdsynopsis>
103
112
    <cmdsynopsis>
104
113
      <command>&COMMANDNAME;</command>
227
236
        <term><option>--priority <replaceable>
228
237
        PRIORITY</replaceable></option></term>
229
238
        <listitem>
230
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
231
241
        </listitem>
232
242
      </varlistentry>
233
243
      
285
295
        <term><option>--no-restore</option></term>
286
296
        <listitem>
287
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
288
301
        </listitem>
289
302
      </varlistentry>
290
303
      
295
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
309
        </listitem>
297
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
      
298
335
    </variablelist>
299
336
  </refsect1>
300
337
  
377
414
      extended timeout, checker program, and interval between checks
378
415
      can be configured both globally and per client; see
379
416
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
417
      <manvolnum>5</manvolnum></citerefentry>.
383
418
    </para>
384
419
  </refsect1>
385
420
  
407
442
    <title>LOGGING</title>
408
443
    <para>
409
444
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
445
      <filename class="devicefile">/dev/log</filename>.  With the
411
446
      <option>--debug</option> option, it will log even more messages,
412
447
      and also show them on the console.
413
448
    </para>
414
449
  </refsect1>
415
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
  
416
463
  <refsect1 id="dbus_interface">
417
464
    <title>D-BUS INTERFACE</title>
418
465
    <para>
480
527
        </listitem>
481
528
      </varlistentry>
482
529
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
530
        <term><filename>/run/mandos.pid</filename></term>
484
531
        <listitem>
485
532
          <para>
486
533
            The file containing the process id of the
487
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.
488
539
          </para>
489
540
        </listitem>
490
541
      </varlistentry>
491
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
492
546
        <term><filename
493
547
        class="directory">/var/lib/mandos</filename></term>
494
548
        <listitem>
532
586
      There is no fine-grained control over logging and debug output.
533
587
    </para>
534
588
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
589
      This server does not check the expire time of clients’ OpenPGP
539
590
      keys.
540
591
    </para>
656
707
      </varlistentry>
657
708
      <varlistentry>
658
709
        <term>
659
 
          <ulink url="http://www.gnu.org/software/gnutls/"
660
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
661
711
        </term>
662
712
      <listitem>
663
713
        <para>
701
751
      </varlistentry>
702
752
      <varlistentry>
703
753
        <term>
704
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
706
756
        </term>
707
757
      <listitem>
708
758
        <para>
709
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
710
760
        </para>
711
761
      </listitem>
712
762
      </varlistentry>
722
772
      </varlistentry>
723
773
      <varlistentry>
724
774
        <term>
725
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
726
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
727
777
        </term>
728
778
      <listitem>
729
779
        <para>