/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

Tags: version-1.0.14-1
* Makefile (version): Changed to "1.0.14".
* NEWS (Version 1.0.14): New entry.
* debian/changelog (1.0.14-1): - '' -

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