/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-09-10 17:21:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090910172136-plhvv6jjz8bjrhz4
* plugins.d/mandos-client.c (init_gnutls_session): Retry interrupted
                                                   GnuTLS functions.
  (main): Drop privileges early, and raise them only where needed and
          lower them whenever possible.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2009-09-10">
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
 
      <year>2017</year>
44
 
      <year>2018</year>
45
36
      <holder>Teddy Hogeborn</holder>
46
37
      <holder>Björn Påhlsson</holder>
47
38
    </copyright>
95
86
      <sbr/>
96
87
      <arg><option>--debug</option></arg>
97
88
      <sbr/>
98
 
      <arg><option>--debuglevel
99
 
      <replaceable>LEVEL</replaceable></option></arg>
100
 
      <sbr/>
101
89
      <arg><option>--no-dbus</option></arg>
102
90
      <sbr/>
103
91
      <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>
116
92
    </cmdsynopsis>
117
93
    <cmdsynopsis>
118
94
      <command>&COMMANDNAME;</command>
136
112
    <para>
137
113
      <command>&COMMANDNAME;</command> is a server daemon which
138
114
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
149
123
    </para>
150
124
  </refsect1>
151
125
  
220
194
      </varlistentry>
221
195
      
222
196
      <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>
241
197
        <term><option>--priority <replaceable>
242
198
        PRIORITY</replaceable></option></term>
243
199
        <listitem>
294
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
251
        </listitem>
296
252
      </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
 
      
339
253
    </variablelist>
340
254
  </refsect1>
341
255
  
415
329
      for some time, the client is assumed to be compromised and is no
416
330
      longer eligible to receive the encrypted password.  (Manual
417
331
      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>
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
421
335
      <manvolnum>5</manvolnum></citerefentry>.
422
336
    </para>
423
337
  </refsect1>
424
338
  
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>
432
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
443
 
  </refsect1>
444
 
  
445
339
  <refsect1 id="logging">
446
340
    <title>LOGGING</title>
447
341
    <para>
448
342
      The server will send log message with various severity levels to
449
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
343
      <filename>/dev/log</filename>.  With the
450
344
      <option>--debug</option> option, it will log even more messages,
451
345
      and also show them on the console.
452
346
    </para>
453
347
  </refsect1>
454
348
  
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
349
  <refsect1 id="dbus_interface">
468
350
    <title>D-BUS INTERFACE</title>
469
351
    <para>
470
352
      The server will by default provide a D-Bus system bus interface.
471
353
      This interface will only be accessible by the root user or a
472
 
      Mandos-specific user, if such a user exists.  For documentation
473
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
354
      Mandos-specific user, if such a user exists.
 
355
      <!-- XXX -->
474
356
    </para>
475
357
  </refsect1>
476
358
  
531
413
        </listitem>
532
414
      </varlistentry>
533
415
      <varlistentry>
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>
 
416
        <term><filename>/var/run/mandos.pid</filename></term>
 
417
        <listitem>
 
418
          <para>
 
419
            The file containing the process id of
 
420
            <command>&COMMANDNAME;</command>.
 
421
          </para>
 
422
        </listitem>
 
423
      </varlistentry>
 
424
      <varlistentry>
 
425
        <term><filename>/dev/log</filename></term>
559
426
        <listitem>
560
427
          <para>
561
428
            The Unix domain socket to where local syslog messages are
584
451
      backtrace.  This could be considered a feature.
585
452
    </para>
586
453
    <para>
 
454
      Currently, if a client is declared <quote>invalid</quote> due to
 
455
      having timed out, the server does not record this fact onto
 
456
      permanent storage.  This has some security implications, see
 
457
      <xref linkend="clients"/>.
 
458
    </para>
 
459
    <para>
 
460
      There is currently no way of querying the server of the current
 
461
      status of clients, other than analyzing its <systemitem
 
462
      class="service">syslog</systemitem> output.
 
463
    </para>
 
464
    <para>
587
465
      There is no fine-grained control over logging and debug output.
588
466
    </para>
589
467
    <para>
 
468
      Debug mode is conflated with running in the foreground.
 
469
    </para>
 
470
    <para>
 
471
      The console log messages do not show a time stamp.
 
472
    </para>
 
473
    <para>
590
474
      This server does not check the expire time of clients’ OpenPGP
591
475
      keys.
592
476
    </para>
593
 
    <xi:include href="bugs.xml"/>
594
477
  </refsect1>
595
478
  
596
479
  <refsect1 id="example">
606
489
    <informalexample>
607
490
      <para>
608
491
        Run the server in debug mode, read configuration files from
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:
 
492
        the <filename>~/mandos</filename> directory, and use the
 
493
        Zeroconf service name <quote>Test</quote> to not collide with
 
494
        any other official Mandos server on this host:
612
495
      </para>
613
496
      <para>
614
497
 
663
546
        compromised if they are gone for too long.
664
547
      </para>
665
548
      <para>
 
549
        If a client is compromised, its downtime should be duly noted
 
550
        by the server which would therefore declare the client
 
551
        invalid.  But if the server was ever restarted, it would
 
552
        re-read its client list from its configuration file and again
 
553
        regard all clients therein as valid, and hence eligible to
 
554
        receive their passwords.  Therefore, be careful when
 
555
        restarting servers if it is suspected that a client has, in
 
556
        fact, been compromised by parties who may now be running a
 
557
        fake Mandos client with the keys from the non-encrypted
 
558
        initial <acronym>RAM</acronym> image of the client host.  What
 
559
        should be done in that case (if restarting the server program
 
560
        really is necessary) is to stop the server program, edit the
 
561
        configuration file to omit any suspect clients, and restart
 
562
        the server program.
 
563
      </para>
 
564
      <para>
666
565
        For more details on client-side security, see
667
566
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
668
567
        <manvolnum>8mandos</manvolnum></citerefentry>.
673
572
  <refsect1 id="see_also">
674
573
    <title>SEE ALSO</title>
675
574
    <para>
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>
 
575
      <citerefentry>
 
576
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
577
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
578
        <refentrytitle>mandos.conf</refentrytitle>
 
579
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
580
        <refentrytitle>mandos-client</refentrytitle>
 
581
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
582
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
583
      </citerefentry>
686
584
    </para>
687
585
    <variablelist>
688
586
      <varlistentry>
709
607
      </varlistentry>
710
608
      <varlistentry>
711
609
        <term>
712
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
610
          <ulink url="http://www.gnu.org/software/gnutls/"
 
611
          >GnuTLS</ulink>
713
612
        </term>
714
613
      <listitem>
715
614
        <para>
753
652
      </varlistentry>
754
653
      <varlistentry>
755
654
        <term>
756
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
 
          Protocol Version 1.2</citetitle>
 
655
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
656
          Protocol Version 1.1</citetitle>
758
657
        </term>
759
658
      <listitem>
760
659
        <para>
761
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
660
          TLS 1.1 is the protocol implemented by GnuTLS.
762
661
        </para>
763
662
      </listitem>
764
663
      </varlistentry>
774
673
      </varlistentry>
775
674
      <varlistentry>
776
675
        <term>
777
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
 
          Security (TLS) Authentication</citetitle>
 
676
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
677
          Security</citetitle>
779
678
        </term>
780
679
      <listitem>
781
680
        <para>