/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: 2018-02-08 10:02:51 UTC
  • Revision ID: teddy@recompile.se-20180208100251-x7qq39sjsgk4r2sq
Update Debian watch file to version 4

* debian/watch (version): Change to "4".
  (opts/pgpsigurlmangle): Remove.
  (opts/pgpmode): New; set to "auto".
  (URL): Change to "https://ftp.recompile.se/pub/@PACKAGE@/@PACKAGE@@ANY_VERSION@(?:\.orig)?@ARCHIVE_EXT@".

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-08-08">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
38
44
      <holder>Teddy Hogeborn</holder>
39
45
      <holder>Björn Påhlsson</holder>
40
46
    </copyright>
94
100
      <arg><option>--no-dbus</option></arg>
95
101
      <sbr/>
96
102
      <arg><option>--no-ipv6</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--no-restore</option></arg>
 
105
      <sbr/>
 
106
      <arg><option>--statedir
 
107
      <replaceable>DIRECTORY</replaceable></option></arg>
 
108
      <sbr/>
 
109
      <arg><option>--socket
 
110
      <replaceable>FD</replaceable></option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--foreground</option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--no-zeroconf</option></arg>
97
115
    </cmdsynopsis>
98
116
    <cmdsynopsis>
99
117
      <command>&COMMANDNAME;</command>
275
293
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
276
294
        </listitem>
277
295
      </varlistentry>
 
296
      
 
297
      <varlistentry>
 
298
        <term><option>--no-restore</option></term>
 
299
        <listitem>
 
300
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
301
          <para>
 
302
            See also <xref linkend="persistent_state"/>.
 
303
          </para>
 
304
        </listitem>
 
305
      </varlistentry>
 
306
      
 
307
      <varlistentry>
 
308
        <term><option>--statedir
 
309
        <replaceable>DIRECTORY</replaceable></option></term>
 
310
        <listitem>
 
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
312
        </listitem>
 
313
      </varlistentry>
 
314
      
 
315
      <varlistentry>
 
316
        <term><option>--socket
 
317
        <replaceable>FD</replaceable></option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>--foreground</option></term>
 
325
        <listitem>
 
326
          <xi:include href="mandos-options.xml"
 
327
                      xpointer="foreground"/>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--no-zeroconf</option></term>
 
333
        <listitem>
 
334
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
335
        </listitem>
 
336
      </varlistentry>
 
337
      
278
338
    </variablelist>
279
339
  </refsect1>
280
340
  
357
417
      extended timeout, checker program, and interval between checks
358
418
      can be configured both globally and per client; see
359
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
361
 
      receiving its password will also be treated as a successful
362
 
      checker run.
 
420
      <manvolnum>5</manvolnum></citerefentry>.
363
421
    </para>
364
422
  </refsect1>
365
423
  
387
445
    <title>LOGGING</title>
388
446
    <para>
389
447
      The server will send log message with various severity levels to
390
 
      <filename>/dev/log</filename>.  With the
 
448
      <filename class="devicefile">/dev/log</filename>.  With the
391
449
      <option>--debug</option> option, it will log even more messages,
392
450
      and also show them on the console.
393
451
    </para>
394
452
  </refsect1>
395
453
  
 
454
  <refsect1 id="persistent_state">
 
455
    <title>PERSISTENT STATE</title>
 
456
    <para>
 
457
      Client settings, initially read from
 
458
      <filename>clients.conf</filename>, are persistent across
 
459
      restarts, and run-time changes will override settings in
 
460
      <filename>clients.conf</filename>.  However, if a setting is
 
461
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
462
      <filename>clients.conf</filename>, this will take precedence.
 
463
    </para>
 
464
  </refsect1>
 
465
  
396
466
  <refsect1 id="dbus_interface">
397
467
    <title>D-BUS INTERFACE</title>
398
468
    <para>
460
530
        </listitem>
461
531
      </varlistentry>
462
532
      <varlistentry>
463
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
464
534
        <listitem>
465
535
          <para>
466
536
            The file containing the process id of the
467
537
            <command>&COMMANDNAME;</command> process started last.
468
 
          </para>
469
 
        </listitem>
470
 
      </varlistentry>
471
 
      <varlistentry>
472
 
        <term><filename>/dev/log</filename></term>
 
538
            <emphasis >Note:</emphasis> If the <filename
 
539
            class="directory">/run</filename> directory does not
 
540
            exist, <filename>/var/run/mandos.pid</filename> will be
 
541
            used instead.
 
542
          </para>
 
543
        </listitem>
 
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 class="devicefile">/dev/log</filename></term>
473
558
        <listitem>
474
559
          <para>
475
560
            The Unix domain socket to where local syslog messages are
498
583
      backtrace.  This could be considered a feature.
499
584
    </para>
500
585
    <para>
501
 
      Currently, if a client is disabled due to having timed out, the
502
 
      server does not record this fact onto permanent storage.  This
503
 
      has some security implications, see <xref linkend="clients"/>.
504
 
    </para>
505
 
    <para>
506
586
      There is no fine-grained control over logging and debug output.
507
587
    </para>
508
588
    <para>
509
 
      Debug mode is conflated with running in the foreground.
510
 
    </para>
511
 
    <para>
512
 
      The console log messages do not show a time stamp.
513
 
    </para>
514
 
    <para>
515
589
      This server does not check the expire time of clients’ OpenPGP
516
590
      keys.
517
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
518
593
  </refsect1>
519
594
  
520
595
  <refsect1 id="example">
530
605
    <informalexample>
531
606
      <para>
532
607
        Run the server in debug mode, read configuration files from
533
 
        the <filename>~/mandos</filename> directory, and use the
534
 
        Zeroconf service name <quote>Test</quote> to not collide with
535
 
        any other official Mandos server on this host:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
536
611
      </para>
537
612
      <para>
538
613
 
587
662
        compromised if they are gone for too long.
588
663
      </para>
589
664
      <para>
590
 
        If a client is compromised, its downtime should be duly noted
591
 
        by the server which would therefore disable the client.  But
592
 
        if the server was ever restarted, it would re-read its client
593
 
        list from its configuration file and again regard all clients
594
 
        therein as enabled, and hence eligible to receive their
595
 
        passwords.  Therefore, be careful when restarting servers if
596
 
        it is suspected that a client has, in fact, been compromised
597
 
        by parties who may now be running a fake Mandos client with
598
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
599
 
        image of the client host.  What should be done in that case
600
 
        (if restarting the server program really is necessary) is to
601
 
        stop the server program, edit the configuration file to omit
602
 
        any suspect clients, and restart the server program.
603
 
      </para>
604
 
      <para>
605
665
        For more details on client-side security, see
606
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
607
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
648
708
      </varlistentry>
649
709
      <varlistentry>
650
710
        <term>
651
 
          <ulink url="http://www.gnu.org/software/gnutls/"
652
 
          >GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
653
712
        </term>
654
713
      <listitem>
655
714
        <para>
693
752
      </varlistentry>
694
753
      <varlistentry>
695
754
        <term>
696
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
697
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
698
757
        </term>
699
758
      <listitem>
700
759
        <para>
701
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
702
761
        </para>
703
762
      </listitem>
704
763
      </varlistentry>
714
773
      </varlistentry>
715
774
      <varlistentry>
716
775
        <term>
717
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
718
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
719
778
        </term>
720
779
      <listitem>
721
780
        <para>