/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

Rename all D-Bus properties to conform to D-Bus naming conventions;
all programs changed.

Also rename client setting "approved_delay" to "approval_delay", and
"approved_duration" to "approval_duration"; all programs changed.

* mandos (ClientDBus.NeedApproval): Bug fix: send an UInt64, not a
                                    float.
  (ClientDBus.ApprovedByDefault_dbus_property,
  ClientDBus.ApprovalDelay_dbus_property,
  ClientDBus.ApprovalDuration_dbus_property): Bug fix: send
                                              PropertyChanged signal.

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 "2016-03-05">
 
5
<!ENTITY TIMESTAMP "2009-12-09">
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>.
420
 
    </para>
421
 
  </refsect1>
422
 
  
423
 
  <refsect1 id="approval">
424
 
    <title>APPROVAL</title>
425
 
    <para>
426
 
      The server can be configured to require manual approval for a
427
 
      client before it is sent its secret.  The delay to wait for such
428
 
      approval and the default action (approve or deny) can be
429
 
      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>
430
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
431
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
432
 
      will be approved immediately without delay.
433
 
    </para>
434
 
    <para>
435
 
      This can be used to deny a client its secret if not manually
436
 
      approved within a specified time.  It can also be used to make
437
 
      the server delay before giving a client its secret, allowing
438
 
      optional manual denying of this specific client.
439
 
    </para>
440
 
    
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
 
338
    </para>
441
339
  </refsect1>
442
340
  
443
341
  <refsect1 id="logging">
444
342
    <title>LOGGING</title>
445
343
    <para>
446
344
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
448
346
      <option>--debug</option> option, it will log even more messages,
449
347
      and also show them on the console.
450
348
    </para>
451
349
  </refsect1>
452
350
  
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
351
  <refsect1 id="dbus_interface">
466
352
    <title>D-BUS INTERFACE</title>
467
353
    <para>
468
354
      The server will by default provide a D-Bus system bus interface.
469
355
      This interface will only be accessible by the root user or a
470
 
      Mandos-specific user, if such a user exists.  For documentation
471
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
356
      Mandos-specific user, if such a user exists.
 
357
      <!-- XXX -->
472
358
    </para>
473
359
  </refsect1>
474
360
  
529
415
        </listitem>
530
416
      </varlistentry>
531
417
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
533
 
        <listitem>
534
 
          <para>
535
 
            The file containing the process id of the
536
 
            <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>
 
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>.
 
423
          </para>
 
424
        </listitem>
 
425
      </varlistentry>
 
426
      <varlistentry>
 
427
        <term><filename>/dev/log</filename></term>
557
428
        <listitem>
558
429
          <para>
559
430
            The Unix domain socket to where local syslog messages are
582
453
      backtrace.  This could be considered a feature.
583
454
    </para>
584
455
    <para>
 
456
      Currently, if a client is disabled due to having timed out, the
 
457
      server does not record this fact onto permanent storage.  This
 
458
      has some security implications, see <xref linkend="clients"/>.
 
459
    </para>
 
460
    <para>
 
461
      There is currently no way of querying the server of the current
 
462
      status of clients, other than analyzing its <systemitem
 
463
      class="service">syslog</systemitem> output.
 
464
    </para>
 
465
    <para>
585
466
      There is no fine-grained control over logging and debug output.
586
467
    </para>
587
468
    <para>
 
469
      Debug mode is conflated with running in the foreground.
 
470
    </para>
 
471
    <para>
 
472
      The console log messages do not show a time stamp.
 
473
    </para>
 
474
    <para>
588
475
      This server does not check the expire time of clients’ OpenPGP
589
476
      keys.
590
477
    </para>
591
 
    <xi:include href="bugs.xml"/>
592
478
  </refsect1>
593
479
  
594
480
  <refsect1 id="example">
604
490
    <informalexample>
605
491
      <para>
606
492
        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:
 
493
        the <filename>~/mandos</filename> directory, and use the
 
494
        Zeroconf service name <quote>Test</quote> to not collide with
 
495
        any other official Mandos server on this host:
610
496
      </para>
611
497
      <para>
612
498
 
661
547
        compromised if they are gone for too long.
662
548
      </para>
663
549
      <para>
 
550
        If a client is compromised, its downtime should be duly noted
 
551
        by the server which would therefore disable the client.  But
 
552
        if the server was ever restarted, it would re-read its client
 
553
        list from its configuration file and again regard all clients
 
554
        therein as enabled, and hence eligible to receive their
 
555
        passwords.  Therefore, be careful when restarting servers if
 
556
        it is suspected that a client has, in fact, been compromised
 
557
        by parties who may now be running a fake Mandos client with
 
558
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
559
        image of the client host.  What should be done in that case
 
560
        (if restarting the server program really is necessary) is to
 
561
        stop the server program, edit the configuration file to omit
 
562
        any suspect clients, and restart the server program.
 
563
      </para>
 
564
      <para>
664
565
        For more details on client-side security, see
665
566
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
666
567
        <manvolnum>8mandos</manvolnum></citerefentry>.
671
572
  <refsect1 id="see_also">
672
573
    <title>SEE ALSO</title>
673
574
    <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>
 
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>
684
584
    </para>
685
585
    <variablelist>
686
586
      <varlistentry>
707
607
      </varlistentry>
708
608
      <varlistentry>
709
609
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
610
          <ulink url="http://www.gnu.org/software/gnutls/"
 
611
          >GnuTLS</ulink>
711
612
        </term>
712
613
      <listitem>
713
614
        <para>
751
652
      </varlistentry>
752
653
      <varlistentry>
753
654
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
655
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
656
          Protocol Version 1.1</citetitle>
756
657
        </term>
757
658
      <listitem>
758
659
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
660
          TLS 1.1 is the protocol implemented by GnuTLS.
760
661
        </para>
761
662
      </listitem>
762
663
      </varlistentry>
772
673
      </varlistentry>
773
674
      <varlistentry>
774
675
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
676
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
677
          Security</citetitle>
777
678
        </term>
778
679
      <listitem>
779
680
        <para>