/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: 2009-11-03 00:12:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091103001235-op9jfvtx6xvxch3h
* README (FAQ): Fix typo.
* mandos (main): Try to always do cleanup() before exit, since
                 otherwise the D-Bus bus name gets unregistered first.

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