/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-01-04 21:20:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104212050-cl2px2i2oz7wlxw1
* debian/control (Build-Depends): Bug fix: Added "docbook-xml".

* mandos (main): Keep running even if no clients are defined.

* mandos.xml (OPTIONS): Bug fix: Close unclosed <para> tag.
  (D-BUS INTERFACE): Changed id to "dbus_interface".  All references
                     changed.

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 "2013-10-23">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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
      
281
240
          </para>
282
241
        </listitem>
283
242
      </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
 
      
326
243
    </variablelist>
327
244
  </refsect1>
328
245
  
400
317
      The server will, by default, continually check that the clients
401
318
      are still up.  If a client has not been confirmed as being up
402
319
      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>
 
320
      longer eligible to receive the encrypted password.  The timeout,
 
321
      checker program, and interval between checks can be configured
 
322
      both globally and per client; see <citerefentry>
 
323
      <refentrytitle>mandos-clients.conf</refentrytitle>
408
324
      <manvolnum>5</manvolnum></citerefentry>.
409
325
    </para>
410
326
  </refsect1>
411
327
  
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
328
  <refsect1 id="logging">
433
329
    <title>LOGGING</title>
434
330
    <para>
435
331
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
332
      <filename>/dev/log</filename>.  With the
437
333
      <option>--debug</option> option, it will log even more messages,
438
334
      and also show them on the console.
439
335
    </para>
440
336
  </refsect1>
441
337
  
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
338
  <refsect1 id="dbus_interface">
455
339
    <title>D-BUS INTERFACE</title>
456
340
    <para>
457
341
      The server will by default provide a D-Bus system bus interface.
458
342
      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>.
 
343
      Mandos-specific user, if such a user exists.
 
344
      <!-- XXX -->
461
345
    </para>
462
346
  </refsect1>
463
 
  
 
347
 
464
348
  <refsect1 id="exit_status">
465
349
    <title>EXIT STATUS</title>
466
350
    <para>
518
402
        </listitem>
519
403
      </varlistentry>
520
404
      <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
 
          </para>
527
 
        </listitem>
528
 
      </varlistentry>
529
 
      <varlistentry>
530
 
        <term><filename class="devicefile">/dev/log</filename></term>
531
 
      </varlistentry>
532
 
      <varlistentry>
533
 
        <term><filename
534
 
        class="directory">/var/lib/mandos</filename></term>
535
 
        <listitem>
536
 
          <para>
537
 
            Directory where persistent state will be saved.  Change
538
 
            this with the <option>--statedir</option> option.  See
539
 
            also the <option>--no-restore</option> option.
 
405
        <term><filename>/var/run/mandos.pid</filename></term>
 
406
        <listitem>
 
407
          <para>
 
408
            The file containing the process id of
 
409
            <command>&COMMANDNAME;</command>.
540
410
          </para>
541
411
        </listitem>
542
412
      </varlistentry>
570
440
      backtrace.  This could be considered a feature.
571
441
    </para>
572
442
    <para>
 
443
      Currently, if a client is declared <quote>invalid</quote> due to
 
444
      having timed out, the server does not record this fact onto
 
445
      permanent storage.  This has some security implications, see
 
446
      <xref linkend="clients"/>.
 
447
    </para>
 
448
    <para>
 
449
      There is currently no way of querying the server of the current
 
450
      status of clients, other than analyzing its <systemitem
 
451
      class="service">syslog</systemitem> output.
 
452
    </para>
 
453
    <para>
573
454
      There is no fine-grained control over logging and debug output.
574
455
    </para>
575
456
    <para>
 
457
      Debug mode is conflated with running in the foreground.
 
458
    </para>
 
459
    <para>
 
460
      The console log messages does not show a time stamp.
 
461
    </para>
 
462
    <para>
576
463
      This server does not check the expire time of clients’ OpenPGP
577
464
      keys.
578
465
    </para>
591
478
    <informalexample>
592
479
      <para>
593
480
        Run the server in debug mode, read configuration files from
594
 
        the <filename class="directory">~/mandos</filename> directory,
595
 
        and use the Zeroconf service name <quote>Test</quote> to not
596
 
        collide with any other official Mandos server on this host:
 
481
        the <filename>~/mandos</filename> directory, and use the
 
482
        Zeroconf service name <quote>Test</quote> to not collide with
 
483
        any other official Mandos server on this host:
597
484
      </para>
598
485
      <para>
599
486
 
648
535
        compromised if they are gone for too long.
649
536
      </para>
650
537
      <para>
 
538
        If a client is compromised, its downtime should be duly noted
 
539
        by the server which would therefore declare the client
 
540
        invalid.  But if the server was ever restarted, it would
 
541
        re-read its client list from its configuration file and again
 
542
        regard all clients therein as valid, and hence eligible to
 
543
        receive their passwords.  Therefore, be careful when
 
544
        restarting servers if it is suspected that a client has, in
 
545
        fact, been compromised by parties who may now be running a
 
546
        fake Mandos client with the keys from the non-encrypted
 
547
        initial <acronym>RAM</acronym> image of the client host.  What
 
548
        should be done in that case (if restarting the server program
 
549
        really is necessary) is to stop the server program, edit the
 
550
        configuration file to omit any suspect clients, and restart
 
551
        the server program.
 
552
      </para>
 
553
      <para>
651
554
        For more details on client-side security, see
652
555
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
653
556
        <manvolnum>8mandos</manvolnum></citerefentry>.
658
561
  <refsect1 id="see_also">
659
562
    <title>SEE ALSO</title>
660
563
    <para>
661
 
      <citerefentry><refentrytitle>intro</refentrytitle>
662
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
663
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
664
 
      <manvolnum>5</manvolnum></citerefentry>,
665
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
666
 
      <manvolnum>5</manvolnum></citerefentry>,
667
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
668
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
669
 
      <citerefentry><refentrytitle>sh</refentrytitle>
670
 
      <manvolnum>1</manvolnum></citerefentry>
 
564
      <citerefentry>
 
565
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
566
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
567
        <refentrytitle>mandos.conf</refentrytitle>
 
568
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
569
        <refentrytitle>mandos-client</refentrytitle>
 
570
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
571
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
572
      </citerefentry>
671
573
    </para>
672
574
    <variablelist>
673
575
      <varlistentry>