/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-12-03 21:06:34 UTC
  • Revision ID: teddy@recompile.se-20151203210634-5dcyccalld40cygn
http://bugs.debian.org/806073
* debian/rules (override_dh_fixperms): Split into
                                       "override_dh_fixperms-arch" and
                                       "override_dh_fixperms-indep".
                                       Fixes Debian bug #806073.

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-02-27">
 
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>
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>
38
42
      <holder>Teddy Hogeborn</holder>
39
43
      <holder>Björn Påhlsson</holder>
40
44
    </copyright>
94
98
      <arg><option>--no-dbus</option></arg>
95
99
      <sbr/>
96
100
      <arg><option>--no-ipv6</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-restore</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--statedir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--socket
 
108
      <replaceable>FD</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--foreground</option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--no-zeroconf</option></arg>
97
113
    </cmdsynopsis>
98
114
    <cmdsynopsis>
99
115
      <command>&COMMANDNAME;</command>
117
133
    <para>
118
134
      <command>&COMMANDNAME;</command> is a server daemon which
119
135
      handles incoming request for passwords for a pre-defined list of
120
 
      client host computers.  The Mandos server uses Zeroconf to
121
 
      announce itself on the local network, and uses TLS to
122
 
      communicate securely with and to authenticate the clients.  The
123
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
124
 
      link-local addresses, since the clients will probably not have
125
 
      any other addresses configured (see <xref linkend="overview"/>).
126
 
      Any authenticated client is then given the stored pre-encrypted
127
 
      password for that specific client.
 
136
      client host computers. For an introduction, see
 
137
      <citerefentry><refentrytitle>intro</refentrytitle>
 
138
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
139
      uses Zeroconf to announce itself on the local network, and uses
 
140
      TLS to communicate securely with and to authenticate the
 
141
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
142
      use IPv6 link-local addresses, since the clients will probably
 
143
      not have any other addresses configured (see <xref
 
144
      linkend="overview"/>).  Any authenticated client is then given
 
145
      the stored pre-encrypted password for that specific client.
128
146
    </para>
129
147
  </refsect1>
130
148
  
273
291
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
292
        </listitem>
275
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--no-restore</option></term>
 
297
        <listitem>
 
298
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
299
          <para>
 
300
            See also <xref linkend="persistent_state"/>.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term><option>--statedir
 
307
        <replaceable>DIRECTORY</replaceable></option></term>
 
308
        <listitem>
 
309
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
310
        </listitem>
 
311
      </varlistentry>
 
312
      
 
313
      <varlistentry>
 
314
        <term><option>--socket
 
315
        <replaceable>FD</replaceable></option></term>
 
316
        <listitem>
 
317
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>--foreground</option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml"
 
325
                      xpointer="foreground"/>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      
 
329
      <varlistentry>
 
330
        <term><option>--no-zeroconf</option></term>
 
331
        <listitem>
 
332
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
276
336
    </variablelist>
277
337
  </refsect1>
278
338
  
352
412
      for some time, the client is assumed to be compromised and is no
353
413
      longer eligible to receive the encrypted password.  (Manual
354
414
      intervention is required to re-enable a client.)  The timeout,
355
 
      checker program, and interval between checks can be configured
356
 
      both globally and per client; see <citerefentry>
357
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
 
415
      extended timeout, checker program, and interval between checks
 
416
      can be configured both globally and per client; see
 
417
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
418
      <manvolnum>5</manvolnum></citerefentry>.
361
419
    </para>
362
420
  </refsect1>
363
421
  
385
443
    <title>LOGGING</title>
386
444
    <para>
387
445
      The server will send log message with various severity levels to
388
 
      <filename>/dev/log</filename>.  With the
 
446
      <filename class="devicefile">/dev/log</filename>.  With the
389
447
      <option>--debug</option> option, it will log even more messages,
390
448
      and also show them on the console.
391
449
    </para>
392
450
  </refsect1>
393
451
  
 
452
  <refsect1 id="persistent_state">
 
453
    <title>PERSISTENT STATE</title>
 
454
    <para>
 
455
      Client settings, initially read from
 
456
      <filename>clients.conf</filename>, are persistent across
 
457
      restarts, and run-time changes will override settings in
 
458
      <filename>clients.conf</filename>.  However, if a setting is
 
459
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
460
      <filename>clients.conf</filename>, this will take precedence.
 
461
    </para>
 
462
  </refsect1>
 
463
  
394
464
  <refsect1 id="dbus_interface">
395
465
    <title>D-BUS INTERFACE</title>
396
466
    <para>
458
528
        </listitem>
459
529
      </varlistentry>
460
530
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
531
        <term><filename>/run/mandos.pid</filename></term>
462
532
        <listitem>
463
533
          <para>
464
534
            The file containing the process id of the
465
535
            <command>&COMMANDNAME;</command> process started last.
 
536
            <emphasis >Note:</emphasis> If the <filename
 
537
            class="directory">/run</filename> directory does not
 
538
            exist, <filename>/var/run/mandos.pid</filename> will be
 
539
            used instead.
 
540
          </para>
 
541
        </listitem>
 
542
      </varlistentry>
 
543
      <varlistentry>
 
544
        <term><filename class="devicefile">/dev/log</filename></term>
 
545
      </varlistentry>
 
546
      <varlistentry>
 
547
        <term><filename
 
548
        class="directory">/var/lib/mandos</filename></term>
 
549
        <listitem>
 
550
          <para>
 
551
            Directory where persistent state will be saved.  Change
 
552
            this with the <option>--statedir</option> option.  See
 
553
            also the <option>--no-restore</option> option.
466
554
          </para>
467
555
        </listitem>
468
556
      </varlistentry>
496
584
      backtrace.  This could be considered a feature.
497
585
    </para>
498
586
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
502
 
    </para>
503
 
    <para>
504
587
      There is no fine-grained control over logging and debug output.
505
588
    </para>
506
589
    <para>
507
 
      Debug mode is conflated with running in the foreground.
508
 
    </para>
509
 
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
590
      This server does not check the expire time of clients’ OpenPGP
514
591
      keys.
515
592
    </para>
528
605
    <informalexample>
529
606
      <para>
530
607
        Run the server in debug mode, read configuration files from
531
 
        the <filename>~/mandos</filename> directory, and use the
532
 
        Zeroconf service name <quote>Test</quote> to not collide with
533
 
        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:
534
611
      </para>
535
612
      <para>
536
613
 
585
662
        compromised if they are gone for too long.
586
663
      </para>
587
664
      <para>
588
 
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
601
 
      </para>
602
 
      <para>
603
665
        For more details on client-side security, see
604
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
605
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
610
672
  <refsect1 id="see_also">
611
673
    <title>SEE ALSO</title>
612
674
    <para>
613
 
      <citerefentry>
614
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
615
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
 
        <refentrytitle>mandos.conf</refentrytitle>
617
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
619
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
 
      </citerefentry>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
622
685
    </para>
623
686
    <variablelist>
624
687
      <varlistentry>
645
708
      </varlistentry>
646
709
      <varlistentry>
647
710
        <term>
648
 
          <ulink url="http://www.gnu.org/software/gnutls/"
649
 
          >GnuTLS</ulink>
 
711
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
650
712
        </term>
651
713
      <listitem>
652
714
        <para>
690
752
      </varlistentry>
691
753
      <varlistentry>
692
754
        <term>
693
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
694
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
695
757
        </term>
696
758
      <listitem>
697
759
        <para>
698
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
699
761
        </para>
700
762
      </listitem>
701
763
      </varlistentry>
711
773
      </varlistentry>
712
774
      <varlistentry>
713
775
        <term>
714
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
715
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
716
778
        </term>
717
779
      <listitem>
718
780
        <para>