/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

* mandos (MandosServer.Quit): New.

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