/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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-30 18:59:44 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930185944-zjw2s8bsw4gmww7d
* Makefile (uninstall-client): Do not remove obsolete README file.

* debian/rules: Do not change permissions on "/etc/mandos/plugins.d".

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 "2008-09-30">
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>
93
84
      <replaceable>DIRECTORY</replaceable></option></arg>
94
85
      <sbr/>
95
86
      <arg><option>--debug</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--debuglevel
98
 
      <replaceable>LEVEL</replaceable></option></arg>
99
 
      <sbr/>
100
 
      <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
87
    </cmdsynopsis>
116
88
    <cmdsynopsis>
117
89
      <command>&COMMANDNAME;</command>
135
107
    <para>
136
108
      <command>&COMMANDNAME;</command> is a server daemon which
137
109
      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.
 
110
      client host computers.  The Mandos server uses Zeroconf to
 
111
      announce itself on the local network, and uses TLS to
 
112
      communicate securely with and to authenticate the clients.  The
 
113
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
114
      link-local addresses, since the clients will probably not have
 
115
      any other addresses configured (see <xref linkend="overview"/>).
 
116
      Any authenticated client is then given the stored pre-encrypted
 
117
      password for that specific client.
148
118
    </para>
149
119
  </refsect1>
150
120
  
219
189
      </varlistentry>
220
190
      
221
191
      <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
192
        <term><option>--priority <replaceable>
241
193
        PRIORITY</replaceable></option></term>
242
194
        <listitem>
276
228
          </para>
277
229
        </listitem>
278
230
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>--no-dbus</option></term>
282
 
        <listitem>
283
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
284
 
          <para>
285
 
            See also <xref linkend="dbus_interface"/>.
286
 
          </para>
287
 
        </listitem>
288
 
      </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
231
    </variablelist>
339
232
  </refsect1>
340
233
  
412
305
      The server will, by default, continually check that the clients
413
306
      are still up.  If a client has not been confirmed as being up
414
307
      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>
 
308
      longer eligible to receive the encrypted password.  The timeout,
 
309
      checker program, and interval between checks can be configured
 
310
      both globally and per client; see <citerefentry>
 
311
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
312
      <manvolnum>5</manvolnum></citerefentry>.
421
313
    </para>
422
314
  </refsect1>
423
315
  
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
316
  <refsect1 id="logging">
445
317
    <title>LOGGING</title>
446
318
    <para>
447
319
      The server will send log message with various severity levels to
448
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
320
      <filename>/dev/log</filename>.  With the
449
321
      <option>--debug</option> option, it will log even more messages,
450
322
      and also show them on the console.
451
323
    </para>
452
324
  </refsect1>
453
325
  
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
 
  <refsect1 id="dbus_interface">
467
 
    <title>D-BUS INTERFACE</title>
468
 
    <para>
469
 
      The server will by default provide a D-Bus system bus interface.
470
 
      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>.
473
 
    </para>
474
 
  </refsect1>
475
 
  
476
326
  <refsect1 id="exit_status">
477
327
    <title>EXIT STATUS</title>
478
328
    <para>
501
351
    </variablelist>
502
352
  </refsect1>
503
353
  
504
 
  <refsect1 id="files">
 
354
  <refsect1 id="file">
505
355
    <title>FILES</title>
506
356
    <para>
507
357
      Use the <option>--configdir</option> option to change where
530
380
        </listitem>
531
381
      </varlistentry>
532
382
      <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>
 
383
        <term><filename>/var/run/mandos.pid</filename></term>
 
384
        <listitem>
 
385
          <para>
 
386
            The file containing the process id of
 
387
            <command>&COMMANDNAME;</command>.
 
388
          </para>
 
389
        </listitem>
 
390
      </varlistentry>
 
391
      <varlistentry>
 
392
        <term><filename>/dev/log</filename></term>
558
393
        <listitem>
559
394
          <para>
560
395
            The Unix domain socket to where local syslog messages are
583
418
      backtrace.  This could be considered a feature.
584
419
    </para>
585
420
    <para>
 
421
      Currently, if a client is declared <quote>invalid</quote> due to
 
422
      having timed out, the server does not record this fact onto
 
423
      permanent storage.  This has some security implications, see
 
424
      <xref linkend="CLIENTS"/>.
 
425
    </para>
 
426
    <para>
 
427
      There is currently no way of querying the server of the current
 
428
      status of clients, other than analyzing its <systemitem
 
429
      class="service">syslog</systemitem> output.
 
430
    </para>
 
431
    <para>
586
432
      There is no fine-grained control over logging and debug output.
587
433
    </para>
588
434
    <para>
 
435
      Debug mode is conflated with running in the foreground.
 
436
    </para>
 
437
    <para>
 
438
      The console log messages does not show a time stamp.
 
439
    </para>
 
440
    <para>
589
441
      This server does not check the expire time of clients’ OpenPGP
590
442
      keys.
591
443
    </para>
592
 
    <xi:include href="bugs.xml"/>
593
444
  </refsect1>
594
445
  
595
446
  <refsect1 id="example">
605
456
    <informalexample>
606
457
      <para>
607
458
        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:
 
459
        the <filename>~/mandos</filename> directory, and use the
 
460
        Zeroconf service name <quote>Test</quote> to not collide with
 
461
        any other official Mandos server on this host:
611
462
      </para>
612
463
      <para>
613
464
 
632
483
  
633
484
  <refsect1 id="security">
634
485
    <title>SECURITY</title>
635
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
636
487
      <title>SERVER</title>
637
488
      <para>
638
489
        Running this <command>&COMMANDNAME;</command> server program
641
492
        soon after startup.
642
493
      </para>
643
494
    </refsect2>
644
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
645
496
      <title>CLIENTS</title>
646
497
      <para>
647
498
        The server only gives out its stored data to clients which
662
513
        compromised if they are gone for too long.
663
514
      </para>
664
515
      <para>
 
516
        If a client is compromised, its downtime should be duly noted
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial <acronym>RAM</acronym> image of the client host.  What
 
526
        should be done in that case (if restarting the server program
 
527
        really is necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
 
530
      </para>
 
531
      <para>
665
532
        For more details on client-side security, see
666
533
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
667
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
672
539
  <refsect1 id="see_also">
673
540
    <title>SEE ALSO</title>
674
541
    <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>
 
542
      <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>mandos.conf</refentrytitle>
 
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>mandos-client</refentrytitle>
 
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
550
      </citerefentry>
685
551
    </para>
686
552
    <variablelist>
687
553
      <varlistentry>
708
574
      </varlistentry>
709
575
      <varlistentry>
710
576
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
577
          <ulink url="http://www.gnu.org/software/gnutls/"
 
578
          >GnuTLS</ulink>
712
579
        </term>
713
580
      <listitem>
714
581
        <para>
752
619
      </varlistentry>
753
620
      <varlistentry>
754
621
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
622
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
623
          Protocol Version 1.1</citetitle>
757
624
        </term>
758
625
      <listitem>
759
626
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
627
          TLS 1.1 is the protocol implemented by GnuTLS.
761
628
        </para>
762
629
      </listitem>
763
630
      </varlistentry>
773
640
      </varlistentry>
774
641
      <varlistentry>
775
642
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
643
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
644
          Security</citetitle>
778
645
        </term>
779
646
      <listitem>
780
647
        <para>