/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2015-07-12 01:07:14 UTC
  • Revision ID: teddy@recompile.se-20150712010714-peiodtm9ay0nbjs2
plugins.d/mandos-client.c (main): See why it failed to bring up interface.

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-03">
 
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
  
396
442
    <title>LOGGING</title>
397
443
    <para>
398
444
      The server will send log message with various severity levels to
399
 
      <filename>/dev/log</filename>.  With the
 
445
      <filename class="devicefile">/dev/log</filename>.  With the
400
446
      <option>--debug</option> option, it will log even more messages,
401
447
      and also show them on the console.
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.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
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.
477
553
          </para>
478
554
        </listitem>
479
555
      </varlistentry>
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
 
      The console log messages do not show a time stamp.
522
 
    </para>
523
 
    <para>
524
589
      This server does not check the expire time of clients’ OpenPGP
525
590
      keys.
526
591
    </para>
539
604
    <informalexample>
540
605
      <para>
541
606
        Run the server in debug mode, read configuration files from
542
 
        the <filename>~/mandos</filename> directory, and use the
543
 
        Zeroconf service name <quote>Test</quote> to not collide with
544
 
        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:
545
610
      </para>
546
611
      <para>
547
612
 
596
661
        compromised if they are gone for too long.
597
662
      </para>
598
663
      <para>
599
 
        If a client is compromised, its downtime should be duly noted
600
 
        by the server which would therefore disable the client.  But
601
 
        if the server was ever restarted, it would re-read its client
602
 
        list from its configuration file and again regard all clients
603
 
        therein as enabled, and hence eligible to receive their
604
 
        passwords.  Therefore, be careful when restarting servers if
605
 
        it is suspected that a client has, in fact, been compromised
606
 
        by parties who may now be running a fake Mandos client with
607
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
608
 
        image of the client host.  What should be done in that case
609
 
        (if restarting the server program really is necessary) is to
610
 
        stop the server program, edit the configuration file to omit
611
 
        any suspect clients, and restart the server program.
612
 
      </para>
613
 
      <para>
614
664
        For more details on client-side security, see
615
665
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
616
666
        <manvolnum>8mandos</manvolnum></citerefentry>.
657
707
      </varlistentry>
658
708
      <varlistentry>
659
709
        <term>
660
 
          <ulink url="http://www.gnu.org/software/gnutls/"
661
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
662
711
        </term>
663
712
      <listitem>
664
713
        <para>
702
751
      </varlistentry>
703
752
      <varlistentry>
704
753
        <term>
705
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
706
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
707
756
        </term>
708
757
      <listitem>
709
758
        <para>
710
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
711
760
        </para>
712
761
      </listitem>
713
762
      </varlistentry>
723
772
      </varlistentry>
724
773
      <varlistentry>
725
774
        <term>
726
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
727
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
728
777
        </term>
729
778
      <listitem>
730
779
        <para>