/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 at bsnet
  • Date: 2010-08-16 04:30:16 UTC
  • mto: This revision was merged to the branch mainline in revision 419.
  • Revision ID: teddy@fukt.bsnet.se-20100816043016-6wzjp3avb84gaejz
* mandos (main): Bug fix: Don't try to bind to an empty string
                 interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
36
      <holder>Teddy Hogeborn</holder>
43
37
      <holder>Björn Påhlsson</holder>
44
38
    </copyright>
92
86
      <sbr/>
93
87
      <arg><option>--debug</option></arg>
94
88
      <sbr/>
95
 
      <arg><option>--debuglevel
96
 
      <replaceable>LEVEL</replaceable></option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-dbus</option></arg>
99
 
      <sbr/>
100
89
      <arg><option>--no-ipv6</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--no-restore</option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--statedir
105
 
      <replaceable>DIRECTORY</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--socket
108
 
      <replaceable>FD</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--foreground</option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--no-zeroconf</option></arg>
113
90
    </cmdsynopsis>
114
91
    <cmdsynopsis>
115
92
      <command>&COMMANDNAME;</command>
133
110
    <para>
134
111
      <command>&COMMANDNAME;</command> is a server daemon which
135
112
      handles incoming request for passwords for a pre-defined list of
136
 
      client host computers. For an introduction, see
137
 
      <citerefentry><refentrytitle>intro</refentrytitle>
138
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
 
      uses Zeroconf to announce itself on the local network, and uses
140
 
      TLS to communicate securely with and to authenticate the
141
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
142
 
      use IPv6 link-local addresses, since the clients will probably
143
 
      not have any other addresses configured (see <xref
144
 
      linkend="overview"/>).  Any authenticated client is then given
145
 
      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.
146
121
    </para>
147
122
  </refsect1>
148
123
  
217
192
      </varlistentry>
218
193
      
219
194
      <varlistentry>
220
 
        <term><option>--debuglevel
221
 
        <replaceable>LEVEL</replaceable></option></term>
222
 
        <listitem>
223
 
          <para>
224
 
            Set the debugging log level.
225
 
            <replaceable>LEVEL</replaceable> is a string, one of
226
 
            <quote><literal>CRITICAL</literal></quote>,
227
 
            <quote><literal>ERROR</literal></quote>,
228
 
            <quote><literal>WARNING</literal></quote>,
229
 
            <quote><literal>INFO</literal></quote>, or
230
 
            <quote><literal>DEBUG</literal></quote>, in order of
231
 
            increasing verbosity.  The default level is
232
 
            <quote><literal>WARNING</literal></quote>.
233
 
          </para>
234
 
        </listitem>
235
 
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
195
        <term><option>--priority <replaceable>
239
196
        PRIORITY</replaceable></option></term>
240
197
        <listitem>
276
233
      </varlistentry>
277
234
      
278
235
      <varlistentry>
279
 
        <term><option>--no-dbus</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
282
 
          <para>
283
 
            See also <xref linkend="dbus_interface"/>.
284
 
          </para>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
236
        <term><option>--no-ipv6</option></term>
290
237
        <listitem>
291
238
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
239
        </listitem>
293
240
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--no-restore</option></term>
297
 
        <listitem>
298
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
299
 
          <para>
300
 
            See also <xref linkend="persistent_state"/>.
301
 
          </para>
302
 
        </listitem>
303
 
      </varlistentry>
304
 
      
305
 
      <varlistentry>
306
 
        <term><option>--statedir
307
 
        <replaceable>DIRECTORY</replaceable></option></term>
308
 
        <listitem>
309
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
310
 
        </listitem>
311
 
      </varlistentry>
312
 
      
313
 
      <varlistentry>
314
 
        <term><option>--socket
315
 
        <replaceable>FD</replaceable></option></term>
316
 
        <listitem>
317
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      
321
 
      <varlistentry>
322
 
        <term><option>--foreground</option></term>
323
 
        <listitem>
324
 
          <xi:include href="mandos-options.xml"
325
 
                      xpointer="foreground"/>
326
 
        </listitem>
327
 
      </varlistentry>
328
 
      
329
 
      <varlistentry>
330
 
        <term><option>--no-zeroconf</option></term>
331
 
        <listitem>
332
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
 
        </listitem>
334
 
      </varlistentry>
335
 
      
336
241
    </variablelist>
337
242
  </refsect1>
338
243
  
412
317
      for some time, the client is assumed to be compromised and is no
413
318
      longer eligible to receive the encrypted password.  (Manual
414
319
      intervention is required to re-enable a client.)  The timeout,
415
 
      extended timeout, checker program, and interval between checks
416
 
      can be configured both globally and per client; see
417
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
 
      <manvolnum>5</manvolnum></citerefentry>.
419
 
    </para>
420
 
  </refsect1>
421
 
  
422
 
  <refsect1 id="approval">
423
 
    <title>APPROVAL</title>
424
 
    <para>
425
 
      The server can be configured to require manual approval for a
426
 
      client before it is sent its secret.  The delay to wait for such
427
 
      approval and the default action (approve or deny) can be
428
 
      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>
429
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
430
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
431
 
      will be approved immediately without delay.
432
 
    </para>
433
 
    <para>
434
 
      This can be used to deny a client its secret if not manually
435
 
      approved within a specified time.  It can also be used to make
436
 
      the server delay before giving a client its secret, allowing
437
 
      optional manual denying of this specific client.
438
 
    </para>
439
 
    
 
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
324
      receiving its password will also be treated as a successful
 
325
      checker run.
 
326
    </para>
440
327
  </refsect1>
441
328
  
442
329
  <refsect1 id="logging">
443
330
    <title>LOGGING</title>
444
331
    <para>
445
332
      The server will send log message with various severity levels to
446
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
333
      <filename>/dev/log</filename>.  With the
447
334
      <option>--debug</option> option, it will log even more messages,
448
335
      and also show them on the console.
449
336
    </para>
450
337
  </refsect1>
451
338
  
452
 
  <refsect1 id="persistent_state">
453
 
    <title>PERSISTENT STATE</title>
454
 
    <para>
455
 
      Client settings, initially read from
456
 
      <filename>clients.conf</filename>, are persistent across
457
 
      restarts, and run-time changes will override settings in
458
 
      <filename>clients.conf</filename>.  However, if a setting is
459
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
460
 
      <filename>clients.conf</filename>, this will take precedence.
461
 
    </para>
462
 
  </refsect1>
463
 
  
464
 
  <refsect1 id="dbus_interface">
465
 
    <title>D-BUS INTERFACE</title>
466
 
    <para>
467
 
      The server will by default provide a D-Bus system bus interface.
468
 
      This interface will only be accessible by the root user or a
469
 
      Mandos-specific user, if such a user exists.  For documentation
470
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
 
    </para>
472
 
  </refsect1>
473
 
  
474
339
  <refsect1 id="exit_status">
475
340
    <title>EXIT STATUS</title>
476
341
    <para>
528
393
        </listitem>
529
394
      </varlistentry>
530
395
      <varlistentry>
531
 
        <term><filename>/run/mandos.pid</filename></term>
532
 
        <listitem>
533
 
          <para>
534
 
            The file containing the process id of the
535
 
            <command>&COMMANDNAME;</command> process started last.
536
 
            <emphasis >Note:</emphasis> If the <filename
537
 
            class="directory">/run</filename> directory does not
538
 
            exist, <filename>/var/run/mandos.pid</filename> will be
539
 
            used instead.
540
 
          </para>
541
 
        </listitem>
542
 
      </varlistentry>
543
 
      <varlistentry>
544
 
        <term><filename class="devicefile">/dev/log</filename></term>
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.
 
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>.
554
401
          </para>
555
402
        </listitem>
556
403
      </varlistentry>
584
431
      backtrace.  This could be considered a feature.
585
432
    </para>
586
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>
587
445
      There is no fine-grained control over logging and debug output.
588
446
    </para>
589
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>
590
454
      This server does not check the expire time of clients’ OpenPGP
591
455
      keys.
592
456
    </para>
605
469
    <informalexample>
606
470
      <para>
607
471
        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:
 
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:
611
475
      </para>
612
476
      <para>
613
477
 
662
526
        compromised if they are gone for too long.
663
527
      </para>
664
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>
665
545
        For more details on client-side security, see
666
546
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
667
547
        <manvolnum>8mandos</manvolnum></citerefentry>.
672
552
  <refsect1 id="see_also">
673
553
    <title>SEE ALSO</title>
674
554
    <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>
 
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>
685
564
    </para>
686
565
    <variablelist>
687
566
      <varlistentry>
708
587
      </varlistentry>
709
588
      <varlistentry>
710
589
        <term>
711
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
590
          <ulink url="http://www.gnu.org/software/gnutls/"
 
591
          >GnuTLS</ulink>
712
592
        </term>
713
593
      <listitem>
714
594
        <para>
752
632
      </varlistentry>
753
633
      <varlistentry>
754
634
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
635
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
636
          Protocol Version 1.1</citetitle>
757
637
        </term>
758
638
      <listitem>
759
639
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
640
          TLS 1.1 is the protocol implemented by GnuTLS.
761
641
        </para>
762
642
      </listitem>
763
643
      </varlistentry>
773
653
      </varlistentry>
774
654
      <varlistentry>
775
655
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
656
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
657
          Security</citetitle>
778
658
        </term>
779
659
      <listitem>
780
660
        <para>