/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

* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

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 "2013-10-26">
 
5
<!ENTITY TIMESTAMP "2008-12-28">
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
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
90
85
      <sbr/>
91
86
      <arg><option>--debug</option></arg>
92
87
      <sbr/>
93
 
      <arg><option>--debuglevel
94
 
      <replaceable>LEVEL</replaceable></option></arg>
95
 
      <sbr/>
96
88
      <arg><option>--no-dbus</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-ipv6</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--no-restore</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--statedir
103
 
      <replaceable>DIRECTORY</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--socket
106
 
      <replaceable>FD</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--foreground</option></arg>
109
89
    </cmdsynopsis>
110
90
    <cmdsynopsis>
111
91
      <command>&COMMANDNAME;</command>
129
109
    <para>
130
110
      <command>&COMMANDNAME;</command> is a server daemon which
131
111
      handles incoming request for passwords for a pre-defined list of
132
 
      client host computers. For an introduction, see
133
 
      <citerefentry><refentrytitle>intro</refentrytitle>
134
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
 
      uses Zeroconf to announce itself on the local network, and uses
136
 
      TLS to communicate securely with and to authenticate the
137
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
138
 
      use IPv6 link-local addresses, since the clients will probably
139
 
      not have any other addresses configured (see <xref
140
 
      linkend="overview"/>).  Any authenticated client is then given
141
 
      the stored pre-encrypted password for that specific client.
 
112
      client host computers.  The Mandos server uses Zeroconf to
 
113
      announce itself on the local network, and uses TLS to
 
114
      communicate securely with and to authenticate the clients.  The
 
115
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
116
      link-local addresses, since the clients will probably not have
 
117
      any other addresses configured (see <xref linkend="overview"/>).
 
118
      Any authenticated client is then given the stored pre-encrypted
 
119
      password for that specific client.
142
120
    </para>
143
121
  </refsect1>
144
122
  
213
191
      </varlistentry>
214
192
      
215
193
      <varlistentry>
216
 
        <term><option>--debuglevel
217
 
        <replaceable>LEVEL</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Set the debugging log level.
221
 
            <replaceable>LEVEL</replaceable> is a string, one of
222
 
            <quote><literal>CRITICAL</literal></quote>,
223
 
            <quote><literal>ERROR</literal></quote>,
224
 
            <quote><literal>WARNING</literal></quote>,
225
 
            <quote><literal>INFO</literal></quote>, or
226
 
            <quote><literal>DEBUG</literal></quote>, in order of
227
 
            increasing verbosity.  The default level is
228
 
            <quote><literal>WARNING</literal></quote>.
229
 
          </para>
230
 
        </listitem>
231
 
      </varlistentry>
232
 
      
233
 
      <varlistentry>
234
194
        <term><option>--priority <replaceable>
235
195
        PRIORITY</replaceable></option></term>
236
196
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
198
        </listitem>
240
199
      </varlistentry>
241
200
      
277
236
        <listitem>
278
237
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
279
238
          <para>
280
 
            See also <xref linkend="dbus_interface"/>.
281
 
          </para>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-ipv6</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--no-restore</option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
296
 
          <para>
297
 
            See also <xref linkend="persistent_state"/>.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
      
302
 
      <varlistentry>
303
 
        <term><option>--statedir
304
 
        <replaceable>DIRECTORY</replaceable></option></term>
305
 
        <listitem>
306
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
307
 
        </listitem>
308
 
      </varlistentry>
309
 
      
310
 
      <varlistentry>
311
 
        <term><option>--socket
312
 
        <replaceable>FD</replaceable></option></term>
313
 
        <listitem>
314
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
315
 
        </listitem>
316
 
      </varlistentry>
317
 
      
318
 
      <varlistentry>
319
 
        <term><option>--foreground</option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml"
322
 
                      xpointer="foreground"/>
323
 
        </listitem>
324
 
      </varlistentry>
325
 
      
 
239
            See also <xref linkend="dbus"/>.
 
240
        </listitem>
 
241
      </varlistentry>
326
242
    </variablelist>
327
243
  </refsect1>
328
244
  
400
316
      The server will, by default, continually check that the clients
401
317
      are still up.  If a client has not been confirmed as being up
402
318
      for some time, the client is assumed to be compromised and is no
403
 
      longer eligible to receive the encrypted password.  (Manual
404
 
      intervention is required to re-enable a client.)  The timeout,
405
 
      extended timeout, checker program, and interval between checks
406
 
      can be configured both globally and per client; see
407
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
319
      longer eligible to receive the encrypted password.  The timeout,
 
320
      checker program, and interval between checks can be configured
 
321
      both globally and per client; see <citerefentry>
 
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
408
323
      <manvolnum>5</manvolnum></citerefentry>.
409
324
    </para>
410
325
  </refsect1>
411
326
  
412
 
  <refsect1 id="approval">
413
 
    <title>APPROVAL</title>
414
 
    <para>
415
 
      The server can be configured to require manual approval for a
416
 
      client before it is sent its secret.  The delay to wait for such
417
 
      approval and the default action (approve or deny) can be
418
 
      configured both globally and per client; see <citerefentry>
419
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
420
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
421
 
      will be approved immediately without delay.
422
 
    </para>
423
 
    <para>
424
 
      This can be used to deny a client its secret if not manually
425
 
      approved within a specified time.  It can also be used to make
426
 
      the server delay before giving a client its secret, allowing
427
 
      optional manual denying of this specific client.
428
 
    </para>
429
 
    
430
 
  </refsect1>
431
 
  
432
327
  <refsect1 id="logging">
433
328
    <title>LOGGING</title>
434
329
    <para>
435
330
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
331
      <filename>/dev/log</filename>.  With the
437
332
      <option>--debug</option> option, it will log even more messages,
438
333
      and also show them on the console.
439
334
    </para>
440
335
  </refsect1>
441
336
  
442
 
  <refsect1 id="persistent_state">
443
 
    <title>PERSISTENT STATE</title>
444
 
    <para>
445
 
      Client settings, initially read from
446
 
      <filename>clients.conf</filename>, are persistent across
447
 
      restarts, and run-time changes will override settings in
448
 
      <filename>clients.conf</filename>.  However, if a setting is
449
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
450
 
      <filename>clients.conf</filename>, this will take precedence.
451
 
    </para>
452
 
  </refsect1>
453
 
  
454
 
  <refsect1 id="dbus_interface">
 
337
  <refsect1 id="dbus">
455
338
    <title>D-BUS INTERFACE</title>
456
339
    <para>
457
340
      The server will by default provide a D-Bus system bus interface.
458
341
      This interface will only be accessible by the root user or a
459
 
      Mandos-specific user, if such a user exists.  For documentation
460
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
342
      Mandos-specific user, if such a user exists.
 
343
      <!-- XXX -->
461
344
    </para>
462
345
  </refsect1>
463
 
  
 
346
 
464
347
  <refsect1 id="exit_status">
465
348
    <title>EXIT STATUS</title>
466
349
    <para>
518
401
        </listitem>
519
402
      </varlistentry>
520
403
      <varlistentry>
521
 
        <term><filename>/run/mandos.pid</filename></term>
522
 
        <listitem>
523
 
          <para>
524
 
            The file containing the process id of the
525
 
            <command>&COMMANDNAME;</command> process started last.
526
 
            <emphasis >Note:</emphasis> If the <filename
527
 
            class="directory">/run</filename> directory does not
528
 
            exist, <filename>/var/run/mandos.pid</filename> will be
529
 
            used instead.
530
 
          </para>
531
 
        </listitem>
532
 
      </varlistentry>
533
 
      <varlistentry>
534
 
        <term><filename class="devicefile">/dev/log</filename></term>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
 
        <term><filename
538
 
        class="directory">/var/lib/mandos</filename></term>
539
 
        <listitem>
540
 
          <para>
541
 
            Directory where persistent state will be saved.  Change
542
 
            this with the <option>--statedir</option> option.  See
543
 
            also the <option>--no-restore</option> option.
 
404
        <term><filename>/var/run/mandos.pid</filename></term>
 
405
        <listitem>
 
406
          <para>
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
544
409
          </para>
545
410
        </listitem>
546
411
      </varlistentry>
574
439
      backtrace.  This could be considered a feature.
575
440
    </para>
576
441
    <para>
 
442
      Currently, if a client is declared <quote>invalid</quote> due to
 
443
      having timed out, the server does not record this fact onto
 
444
      permanent storage.  This has some security implications, see
 
445
      <xref linkend="clients"/>.
 
446
    </para>
 
447
    <para>
 
448
      There is currently no way of querying the server of the current
 
449
      status of clients, other than analyzing its <systemitem
 
450
      class="service">syslog</systemitem> output.
 
451
    </para>
 
452
    <para>
577
453
      There is no fine-grained control over logging and debug output.
578
454
    </para>
579
455
    <para>
 
456
      Debug mode is conflated with running in the foreground.
 
457
    </para>
 
458
    <para>
 
459
      The console log messages does not show a time stamp.
 
460
    </para>
 
461
    <para>
580
462
      This server does not check the expire time of clients’ OpenPGP
581
463
      keys.
582
464
    </para>
595
477
    <informalexample>
596
478
      <para>
597
479
        Run the server in debug mode, read configuration files from
598
 
        the <filename class="directory">~/mandos</filename> directory,
599
 
        and use the Zeroconf service name <quote>Test</quote> to not
600
 
        collide with any other official Mandos server on this host:
 
480
        the <filename>~/mandos</filename> directory, and use the
 
481
        Zeroconf service name <quote>Test</quote> to not collide with
 
482
        any other official Mandos server on this host:
601
483
      </para>
602
484
      <para>
603
485
 
652
534
        compromised if they are gone for too long.
653
535
      </para>
654
536
      <para>
 
537
        If a client is compromised, its downtime should be duly noted
 
538
        by the server which would therefore declare the client
 
539
        invalid.  But if the server was ever restarted, it would
 
540
        re-read its client list from its configuration file and again
 
541
        regard all clients therein as valid, and hence eligible to
 
542
        receive their passwords.  Therefore, be careful when
 
543
        restarting servers if it is suspected that a client has, in
 
544
        fact, been compromised by parties who may now be running a
 
545
        fake Mandos client with the keys from the non-encrypted
 
546
        initial <acronym>RAM</acronym> image of the client host.  What
 
547
        should be done in that case (if restarting the server program
 
548
        really is necessary) is to stop the server program, edit the
 
549
        configuration file to omit any suspect clients, and restart
 
550
        the server program.
 
551
      </para>
 
552
      <para>
655
553
        For more details on client-side security, see
656
554
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
657
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
662
560
  <refsect1 id="see_also">
663
561
    <title>SEE ALSO</title>
664
562
    <para>
665
 
      <citerefentry><refentrytitle>intro</refentrytitle>
666
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
667
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
 
      <manvolnum>5</manvolnum></citerefentry>,
669
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
 
      <manvolnum>5</manvolnum></citerefentry>,
671
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
672
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
673
 
      <citerefentry><refentrytitle>sh</refentrytitle>
674
 
      <manvolnum>1</manvolnum></citerefentry>
 
563
      <citerefentry>
 
564
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
566
        <refentrytitle>mandos.conf</refentrytitle>
 
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
568
        <refentrytitle>mandos-client</refentrytitle>
 
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
571
      </citerefentry>
675
572
    </para>
676
573
    <variablelist>
677
574
      <varlistentry>