/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

  • Committer: Teddy Hogeborn
  • Date: 2008-10-01 15:29:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001152901-fh30whl3m4vb7m24
* debian/changelog: New Debian revision.

* debian/mandos-client.lintian-overrides: Added comments.
* debian/mandos.lintian-overrides: - '' -

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 "2010-09-25">
 
5
<!ENTITY TIMESTAMP "2008-09-30">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <year>2009</year>
36
35
      <holder>Teddy Hogeborn</holder>
37
36
      <holder>Björn Påhlsson</holder>
38
37
    </copyright>
85
84
      <replaceable>DIRECTORY</replaceable></option></arg>
86
85
      <sbr/>
87
86
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
87
    </cmdsynopsis>
93
88
    <cmdsynopsis>
94
89
      <command>&COMMANDNAME;</command>
233
228
          </para>
234
229
        </listitem>
235
230
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
231
    </variablelist>
254
232
  </refsect1>
255
233
  
327
305
      The server will, by default, continually check that the clients
328
306
      are still up.  If a client has not been confirmed as being up
329
307
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
308
      longer eligible to receive the encrypted password.  The timeout,
332
309
      checker program, and interval between checks can be configured
333
310
      both globally and per client; see <citerefentry>
334
311
      <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.
338
 
    </para>
339
 
  </refsect1>
340
 
  
341
 
  <refsect1 id="approval">
342
 
    <title>APPROVAL</title>
343
 
    <para>
344
 
      The server can be configured to require manual approval for a
345
 
      client before it is sent its secret.  The delay to wait for such
346
 
      approval and the default action (approve or deny) can be
347
 
      configured both globally and per client; see <citerefentry>
348
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
350
 
      will be approved immediately without delay.
351
 
    </para>
352
 
    <para>
353
 
      This can be used to deny a client its secret if not manually
354
 
      approved within a specified time.  It can also be used to make
355
 
      the server delay before giving a client its secret, allowing
356
 
      optional manual denying of this specific client.
357
 
    </para>
358
 
    
 
312
      <manvolnum>5</manvolnum></citerefentry>.
 
313
    </para>
359
314
  </refsect1>
360
315
  
361
316
  <refsect1 id="logging">
368
323
    </para>
369
324
  </refsect1>
370
325
  
371
 
  <refsect1 id="dbus_interface">
372
 
    <title>D-BUS INTERFACE</title>
373
 
    <para>
374
 
      The server will by default provide a D-Bus system bus interface.
375
 
      This interface will only be accessible by the root user or a
376
 
      Mandos-specific user, if such a user exists.  For documentation
377
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
378
 
    </para>
379
 
  </refsect1>
380
 
  
381
326
  <refsect1 id="exit_status">
382
327
    <title>EXIT STATUS</title>
383
328
    <para>
406
351
    </variablelist>
407
352
  </refsect1>
408
353
  
409
 
  <refsect1 id="files">
 
354
  <refsect1 id="file">
410
355
    <title>FILES</title>
411
356
    <para>
412
357
      Use the <option>--configdir</option> option to change where
438
383
        <term><filename>/var/run/mandos.pid</filename></term>
439
384
        <listitem>
440
385
          <para>
441
 
            The file containing the process id of the
442
 
            <command>&COMMANDNAME;</command> process started last.
 
386
            The file containing the process id of
 
387
            <command>&COMMANDNAME;</command>.
443
388
          </para>
444
389
        </listitem>
445
390
      </varlistentry>
473
418
      backtrace.  This could be considered a feature.
474
419
    </para>
475
420
    <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"/>.
 
421
      Currently, if a client is declared <quote>invalid</quote> due to
 
422
      having timed out, the server does not record this fact onto
 
423
      permanent storage.  This has some security implications, see
 
424
      <xref linkend="CLIENTS"/>.
 
425
    </para>
 
426
    <para>
 
427
      There is currently no way of querying the server of the current
 
428
      status of clients, other than analyzing its <systemitem
 
429
      class="service">syslog</systemitem> output.
479
430
    </para>
480
431
    <para>
481
432
      There is no fine-grained control over logging and debug output.
484
435
      Debug mode is conflated with running in the foreground.
485
436
    </para>
486
437
    <para>
487
 
      The console log messages do not show a time stamp.
 
438
      The console log messages does not show a time stamp.
488
439
    </para>
489
440
    <para>
490
441
      This server does not check the expire time of clients’ OpenPGP
532
483
  
533
484
  <refsect1 id="security">
534
485
    <title>SECURITY</title>
535
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
536
487
      <title>SERVER</title>
537
488
      <para>
538
489
        Running this <command>&COMMANDNAME;</command> server program
541
492
        soon after startup.
542
493
      </para>
543
494
    </refsect2>
544
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
545
496
      <title>CLIENTS</title>
546
497
      <para>
547
498
        The server only gives out its stored data to clients which
563
514
      </para>
564
515
      <para>
565
516
        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.
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial <acronym>RAM</acronym> image of the client host.  What
 
526
        should be done in that case (if restarting the server program
 
527
        really is necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
578
530
      </para>
579
531
      <para>
580
532
        For more details on client-side security, see