/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: 2010-09-25 23:52:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
                                to "_" in D-Bus object paths.
  (MandosServer.handle_ipc): Bug fix: Send only address string to
                             D-Bus signal, not whole tuple.

* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
              "--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.

* mandos-monitor (MandosClientWidget.update): Fix spelling.

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 "2016-03-05">
 
5
<!ENTITY TIMESTAMP "2010-09-25">
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
89
      <arg><option>--no-dbus</option></arg>
100
90
      <sbr/>
101
91
      <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
92
    </cmdsynopsis>
115
93
    <cmdsynopsis>
116
94
      <command>&COMMANDNAME;</command>
134
112
    <para>
135
113
      <command>&COMMANDNAME;</command> is a server daemon which
136
114
      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.
 
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.
147
123
    </para>
148
124
  </refsect1>
149
125
  
218
194
      </varlistentry>
219
195
      
220
196
      <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
197
        <term><option>--priority <replaceable>
240
198
        PRIORITY</replaceable></option></term>
241
199
        <listitem>
292
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
251
        </listitem>
294
252
      </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
253
    </variablelist>
338
254
  </refsect1>
339
255
  
413
329
      for some time, the client is assumed to be compromised and is no
414
330
      longer eligible to receive the encrypted password.  (Manual
415
331
      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>.
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
420
338
    </para>
421
339
  </refsect1>
422
340
  
444
362
    <title>LOGGING</title>
445
363
    <para>
446
364
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
365
      <filename>/dev/log</filename>.  With the
448
366
      <option>--debug</option> option, it will log even more messages,
449
367
      and also show them on the console.
450
368
    </para>
451
369
  </refsect1>
452
370
  
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
371
  <refsect1 id="dbus_interface">
466
372
    <title>D-BUS INTERFACE</title>
467
373
    <para>
529
435
        </listitem>
530
436
      </varlistentry>
531
437
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
 
438
        <term><filename>/var/run/mandos.pid</filename></term>
533
439
        <listitem>
534
440
          <para>
535
441
            The file containing the process id of the
536
442
            <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>
 
443
          </para>
 
444
        </listitem>
 
445
      </varlistentry>
 
446
      <varlistentry>
 
447
        <term><filename>/dev/log</filename></term>
557
448
        <listitem>
558
449
          <para>
559
450
            The Unix domain socket to where local syslog messages are
582
473
      backtrace.  This could be considered a feature.
583
474
    </para>
584
475
    <para>
 
476
      Currently, if a client is disabled due to having timed out, the
 
477
      server does not record this fact onto permanent storage.  This
 
478
      has some security implications, see <xref linkend="clients"/>.
 
479
    </para>
 
480
    <para>
585
481
      There is no fine-grained control over logging and debug output.
586
482
    </para>
587
483
    <para>
 
484
      Debug mode is conflated with running in the foreground.
 
485
    </para>
 
486
    <para>
 
487
      The console log messages do not show a time stamp.
 
488
    </para>
 
489
    <para>
588
490
      This server does not check the expire time of clients’ OpenPGP
589
491
      keys.
590
492
    </para>
591
 
    <xi:include href="bugs.xml"/>
592
493
  </refsect1>
593
494
  
594
495
  <refsect1 id="example">
604
505
    <informalexample>
605
506
      <para>
606
507
        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:
 
508
        the <filename>~/mandos</filename> directory, and use the
 
509
        Zeroconf service name <quote>Test</quote> to not collide with
 
510
        any other official Mandos server on this host:
610
511
      </para>
611
512
      <para>
612
513
 
661
562
        compromised if they are gone for too long.
662
563
      </para>
663
564
      <para>
 
565
        If a client is compromised, its downtime should be duly noted
 
566
        by the server which would therefore disable the client.  But
 
567
        if the server was ever restarted, it would re-read its client
 
568
        list from its configuration file and again regard all clients
 
569
        therein as enabled, and hence eligible to receive their
 
570
        passwords.  Therefore, be careful when restarting servers if
 
571
        it is suspected that a client has, in fact, been compromised
 
572
        by parties who may now be running a fake Mandos client with
 
573
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
574
        image of the client host.  What should be done in that case
 
575
        (if restarting the server program really is necessary) is to
 
576
        stop the server program, edit the configuration file to omit
 
577
        any suspect clients, and restart the server program.
 
578
      </para>
 
579
      <para>
664
580
        For more details on client-side security, see
665
581
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
666
582
        <manvolnum>8mandos</manvolnum></citerefentry>.
671
587
  <refsect1 id="see_also">
672
588
    <title>SEE ALSO</title>
673
589
    <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>
 
590
      <citerefentry>
 
591
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
592
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
593
        <refentrytitle>mandos.conf</refentrytitle>
 
594
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
595
        <refentrytitle>mandos-client</refentrytitle>
 
596
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
597
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
598
      </citerefentry>
684
599
    </para>
685
600
    <variablelist>
686
601
      <varlistentry>
707
622
      </varlistentry>
708
623
      <varlistentry>
709
624
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
625
          <ulink url="http://www.gnu.org/software/gnutls/"
 
626
          >GnuTLS</ulink>
711
627
        </term>
712
628
      <listitem>
713
629
        <para>
751
667
      </varlistentry>
752
668
      <varlistentry>
753
669
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
670
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
671
          Protocol Version 1.1</citetitle>
756
672
        </term>
757
673
      <listitem>
758
674
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
675
          TLS 1.1 is the protocol implemented by GnuTLS.
760
676
        </para>
761
677
      </listitem>
762
678
      </varlistentry>
772
688
      </varlistentry>
773
689
      <varlistentry>
774
690
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
691
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
692
          Security</citetitle>
777
693
        </term>
778
694
      <listitem>
779
695
        <para>