/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-09 21:48:47 UTC
  • Revision ID: teddy@recompile.se-20180209214847-z9gcxqa6827z0ir5
Server bug fix: Correct bad argument list

* (mandos/AvahiServiceToSyslog.rename): Remove "self" from the
  arguments to the method when using super().

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 "2008-12-28">
 
5
<!ENTITY TIMESTAMP "2018-02-08">
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>
33
33
    <copyright>
34
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
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>
 
44
      <year>2018</year>
35
45
      <holder>Teddy Hogeborn</holder>
36
46
      <holder>Björn Påhlsson</holder>
37
47
    </copyright>
85
95
      <sbr/>
86
96
      <arg><option>--debug</option></arg>
87
97
      <sbr/>
 
98
      <arg><option>--debuglevel
 
99
      <replaceable>LEVEL</replaceable></option></arg>
 
100
      <sbr/>
88
101
      <arg><option>--no-dbus</option></arg>
 
102
      <sbr/>
 
103
      <arg><option>--no-ipv6</option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--no-restore</option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--statedir
 
108
      <replaceable>DIRECTORY</replaceable></option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--socket
 
111
      <replaceable>FD</replaceable></option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--foreground</option></arg>
 
114
      <sbr/>
 
115
      <arg><option>--no-zeroconf</option></arg>
89
116
    </cmdsynopsis>
90
117
    <cmdsynopsis>
91
118
      <command>&COMMANDNAME;</command>
109
136
    <para>
110
137
      <command>&COMMANDNAME;</command> is a server daemon which
111
138
      handles incoming request for passwords for a pre-defined list of
112
 
      client host computers.  The Mandos server uses Zeroconf to
113
 
      announce itself on the local network, and uses TLS to
114
 
      communicate securely with and to authenticate the clients.  The
115
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
116
 
      link-local addresses, since the clients will probably not have
117
 
      any other addresses configured (see <xref linkend="overview"/>).
118
 
      Any authenticated client is then given the stored pre-encrypted
119
 
      password for that specific client.
 
139
      client host computers. For an introduction, see
 
140
      <citerefentry><refentrytitle>intro</refentrytitle>
 
141
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
142
      uses Zeroconf to announce itself on the local network, and uses
 
143
      TLS to communicate securely with and to authenticate the
 
144
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
145
      use IPv6 link-local addresses, since the clients will probably
 
146
      not have any other addresses configured (see <xref
 
147
      linkend="overview"/>).  Any authenticated client is then given
 
148
      the stored pre-encrypted password for that specific client.
120
149
    </para>
121
150
  </refsect1>
122
151
  
191
220
      </varlistentry>
192
221
      
193
222
      <varlistentry>
 
223
        <term><option>--debuglevel
 
224
        <replaceable>LEVEL</replaceable></option></term>
 
225
        <listitem>
 
226
          <para>
 
227
            Set the debugging log level.
 
228
            <replaceable>LEVEL</replaceable> is a string, one of
 
229
            <quote><literal>CRITICAL</literal></quote>,
 
230
            <quote><literal>ERROR</literal></quote>,
 
231
            <quote><literal>WARNING</literal></quote>,
 
232
            <quote><literal>INFO</literal></quote>, or
 
233
            <quote><literal>DEBUG</literal></quote>, in order of
 
234
            increasing verbosity.  The default level is
 
235
            <quote><literal>WARNING</literal></quote>.
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
194
241
        <term><option>--priority <replaceable>
195
242
        PRIORITY</replaceable></option></term>
196
243
        <listitem>
236
283
        <listitem>
237
284
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
285
          <para>
239
 
            See also <xref linkend="dbus"/>.
240
 
        </listitem>
241
 
      </varlistentry>
 
286
            See also <xref linkend="dbus_interface"/>.
 
287
          </para>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-ipv6</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>--no-restore</option></term>
 
300
        <listitem>
 
301
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
302
          <para>
 
303
            See also <xref linkend="persistent_state"/>.
 
304
          </para>
 
305
        </listitem>
 
306
      </varlistentry>
 
307
      
 
308
      <varlistentry>
 
309
        <term><option>--statedir
 
310
        <replaceable>DIRECTORY</replaceable></option></term>
 
311
        <listitem>
 
312
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
313
        </listitem>
 
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--socket
 
318
        <replaceable>FD</replaceable></option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
 
324
      <varlistentry>
 
325
        <term><option>--foreground</option></term>
 
326
        <listitem>
 
327
          <xi:include href="mandos-options.xml"
 
328
                      xpointer="foreground"/>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
      
 
332
      <varlistentry>
 
333
        <term><option>--no-zeroconf</option></term>
 
334
        <listitem>
 
335
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
336
        </listitem>
 
337
      </varlistentry>
 
338
      
242
339
    </variablelist>
243
340
  </refsect1>
244
341
  
316
413
      The server will, by default, continually check that the clients
317
414
      are still up.  If a client has not been confirmed as being up
318
415
      for some time, the client is assumed to be compromised and is no
319
 
      longer eligible to receive the encrypted password.  The timeout,
320
 
      checker program, and interval between checks can be configured
321
 
      both globally and per client; see <citerefentry>
 
416
      longer eligible to receive the encrypted password.  (Manual
 
417
      intervention is required to re-enable a client.)  The timeout,
 
418
      extended timeout, checker program, and interval between checks
 
419
      can be configured both globally and per client; see
 
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
421
      <manvolnum>5</manvolnum></citerefentry>.
 
422
    </para>
 
423
  </refsect1>
 
424
  
 
425
  <refsect1 id="approval">
 
426
    <title>APPROVAL</title>
 
427
    <para>
 
428
      The server can be configured to require manual approval for a
 
429
      client before it is sent its secret.  The delay to wait for such
 
430
      approval and the default action (approve or deny) can be
 
431
      configured both globally and per client; see <citerefentry>
322
432
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.
324
 
    </para>
 
433
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
434
      will be approved immediately without delay.
 
435
    </para>
 
436
    <para>
 
437
      This can be used to deny a client its secret if not manually
 
438
      approved within a specified time.  It can also be used to make
 
439
      the server delay before giving a client its secret, allowing
 
440
      optional manual denying of this specific client.
 
441
    </para>
 
442
    
325
443
  </refsect1>
326
444
  
327
445
  <refsect1 id="logging">
328
446
    <title>LOGGING</title>
329
447
    <para>
330
448
      The server will send log message with various severity levels to
331
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
332
450
      <option>--debug</option> option, it will log even more messages,
333
451
      and also show them on the console.
334
452
    </para>
335
453
  </refsect1>
336
454
  
337
 
  <refsect1 id="dbus">
 
455
  <refsect1 id="persistent_state">
 
456
    <title>PERSISTENT STATE</title>
 
457
    <para>
 
458
      Client settings, initially read from
 
459
      <filename>clients.conf</filename>, are persistent across
 
460
      restarts, and run-time changes will override settings in
 
461
      <filename>clients.conf</filename>.  However, if a setting is
 
462
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
463
      <filename>clients.conf</filename>, this will take precedence.
 
464
    </para>
 
465
  </refsect1>
 
466
  
 
467
  <refsect1 id="dbus_interface">
338
468
    <title>D-BUS INTERFACE</title>
339
469
    <para>
340
470
      The server will by default provide a D-Bus system bus interface.
341
471
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
 
472
      Mandos-specific user, if such a user exists.  For documentation
 
473
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
344
474
    </para>
345
475
  </refsect1>
346
 
 
 
476
  
347
477
  <refsect1 id="exit_status">
348
478
    <title>EXIT STATUS</title>
349
479
    <para>
401
531
        </listitem>
402
532
      </varlistentry>
403
533
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
405
 
        <listitem>
406
 
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
409
 
          </para>
410
 
        </listitem>
411
 
      </varlistentry>
412
 
      <varlistentry>
413
 
        <term><filename>/dev/log</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
 
535
        <listitem>
 
536
          <para>
 
537
            The file containing the process id of the
 
538
            <command>&COMMANDNAME;</command> process started last.
 
539
            <emphasis >Note:</emphasis> If the <filename
 
540
            class="directory">/run</filename> directory does not
 
541
            exist, <filename>/var/run/mandos.pid</filename> will be
 
542
            used instead.
 
543
          </para>
 
544
        </listitem>
 
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.
 
554
          </para>
 
555
        </listitem>
 
556
      </varlistentry>
 
557
      <varlistentry>
 
558
        <term><filename class="devicefile">/dev/log</filename></term>
414
559
        <listitem>
415
560
          <para>
416
561
            The Unix domain socket to where local syslog messages are
439
584
      backtrace.  This could be considered a feature.
440
585
    </para>
441
586
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
451
 
    </para>
452
 
    <para>
453
587
      There is no fine-grained control over logging and debug output.
454
588
    </para>
455
589
    <para>
456
 
      Debug mode is conflated with running in the foreground.
457
 
    </para>
458
 
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
590
      This server does not check the expire time of clients’ OpenPGP
463
591
      keys.
464
592
    </para>
 
593
    <xi:include href="bugs.xml"/>
465
594
  </refsect1>
466
595
  
467
596
  <refsect1 id="example">
477
606
    <informalexample>
478
607
      <para>
479
608
        Run the server in debug mode, read configuration files from
480
 
        the <filename>~/mandos</filename> directory, and use the
481
 
        Zeroconf service name <quote>Test</quote> to not collide with
482
 
        any other official Mandos server on this host:
 
609
        the <filename class="directory">~/mandos</filename> directory,
 
610
        and use the Zeroconf service name <quote>Test</quote> to not
 
611
        collide with any other official Mandos server on this host:
483
612
      </para>
484
613
      <para>
485
614
 
534
663
        compromised if they are gone for too long.
535
664
      </para>
536
665
      <para>
537
 
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        the server program.
551
 
      </para>
552
 
      <para>
553
666
        For more details on client-side security, see
554
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
555
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
560
673
  <refsect1 id="see_also">
561
674
    <title>SEE ALSO</title>
562
675
    <para>
563
 
      <citerefentry>
564
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
569
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
 
      </citerefentry>
 
676
      <citerefentry><refentrytitle>intro</refentrytitle>
 
677
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
681
      <manvolnum>5</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
683
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
684
      <citerefentry><refentrytitle>sh</refentrytitle>
 
685
      <manvolnum>1</manvolnum></citerefentry>
572
686
    </para>
573
687
    <variablelist>
574
688
      <varlistentry>
595
709
      </varlistentry>
596
710
      <varlistentry>
597
711
        <term>
598
 
          <ulink url="http://www.gnu.org/software/gnutls/"
599
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
600
713
        </term>
601
714
      <listitem>
602
715
        <para>
640
753
      </varlistentry>
641
754
      <varlistentry>
642
755
        <term>
643
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
645
758
        </term>
646
759
      <listitem>
647
760
        <para>
648
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
649
762
        </para>
650
763
      </listitem>
651
764
      </varlistentry>
661
774
      </varlistentry>
662
775
      <varlistentry>
663
776
        <term>
664
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
665
 
          Security</citetitle>
 
777
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
778
          Security (TLS) Authentication</citetitle>
666
779
        </term>
667
780
      <listitem>
668
781
        <para>