/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-11-16 18:10:22 UTC
  • mfrom: (237.5.1 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20101116181022-oz0dahg0q4jnyb0y
Merge from Björn

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 "2008-09-30">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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
      <year>2010</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
84
86
      <replaceable>DIRECTORY</replaceable></option></arg>
85
87
      <sbr/>
86
88
      <arg><option>--debug</option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--debuglevel
 
91
      <replaceable>LEVEL</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--no-dbus</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-ipv6</option></arg>
87
96
    </cmdsynopsis>
88
97
    <cmdsynopsis>
89
98
      <command>&COMMANDNAME;</command>
189
198
      </varlistentry>
190
199
      
191
200
      <varlistentry>
 
201
        <term><option>--debuglevel
 
202
        <replaceable>LEVEL</replaceable></option></term>
 
203
        <listitem>
 
204
          <para>
 
205
            Set the debugging log level.
 
206
            <replaceable>LEVEL</replaceable> is a string, one of
 
207
            <quote><literal>CRITICAL</literal></quote>,
 
208
            <quote><literal>ERROR</literal></quote>,
 
209
            <quote><literal>WARNING</literal></quote>,
 
210
            <quote><literal>INFO</literal></quote>, or
 
211
            <quote><literal>DEBUG</literal></quote>, in order of
 
212
            increasing verbosity.  The default level is
 
213
            <quote><literal>WARNING</literal></quote>.
 
214
          </para>
 
215
        </listitem>
 
216
      </varlistentry>
 
217
      
 
218
      <varlistentry>
192
219
        <term><option>--priority <replaceable>
193
220
        PRIORITY</replaceable></option></term>
194
221
        <listitem>
228
255
          </para>
229
256
        </listitem>
230
257
      </varlistentry>
 
258
      
 
259
      <varlistentry>
 
260
        <term><option>--no-dbus</option></term>
 
261
        <listitem>
 
262
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
263
          <para>
 
264
            See also <xref linkend="dbus_interface"/>.
 
265
          </para>
 
266
        </listitem>
 
267
      </varlistentry>
 
268
      
 
269
      <varlistentry>
 
270
        <term><option>--no-ipv6</option></term>
 
271
        <listitem>
 
272
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
273
        </listitem>
 
274
      </varlistentry>
231
275
    </variablelist>
232
276
  </refsect1>
233
277
  
305
349
      The server will, by default, continually check that the clients
306
350
      are still up.  If a client has not been confirmed as being up
307
351
      for some time, the client is assumed to be compromised and is no
308
 
      longer eligible to receive the encrypted password.  The timeout,
 
352
      longer eligible to receive the encrypted password.  (Manual
 
353
      intervention is required to re-enable a client.)  The timeout,
309
354
      checker program, and interval between checks can be configured
310
355
      both globally and per client; see <citerefentry>
311
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
312
 
      <manvolnum>5</manvolnum></citerefentry>.
313
 
    </para>
 
357
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
358
      receiving its password will also be treated as a successful
 
359
      checker run.
 
360
    </para>
 
361
  </refsect1>
 
362
  
 
363
  <refsect1 id="approval">
 
364
    <title>APPROVAL</title>
 
365
    <para>
 
366
      The server can be configured to require manual approval for a
 
367
      client before it is sent its secret.  The delay to wait for such
 
368
      approval and the default action (approve or deny) can be
 
369
      configured both globally and per client; see <citerefentry>
 
370
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
371
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
372
      will be approved immediately without delay.
 
373
    </para>
 
374
    <para>
 
375
      This can be used to deny a client its secret if not manually
 
376
      approved within a specified time.  It can also be used to make
 
377
      the server delay before giving a client its secret, allowing
 
378
      optional manual denying of this specific client.
 
379
    </para>
 
380
    
314
381
  </refsect1>
315
382
  
316
383
  <refsect1 id="logging">
323
390
    </para>
324
391
  </refsect1>
325
392
  
 
393
  <refsect1 id="dbus_interface">
 
394
    <title>D-BUS INTERFACE</title>
 
395
    <para>
 
396
      The server will by default provide a D-Bus system bus interface.
 
397
      This interface will only be accessible by the root user or a
 
398
      Mandos-specific user, if such a user exists.  For documentation
 
399
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
400
    </para>
 
401
  </refsect1>
 
402
  
326
403
  <refsect1 id="exit_status">
327
404
    <title>EXIT STATUS</title>
328
405
    <para>
351
428
    </variablelist>
352
429
  </refsect1>
353
430
  
354
 
  <refsect1 id="file">
 
431
  <refsect1 id="files">
355
432
    <title>FILES</title>
356
433
    <para>
357
434
      Use the <option>--configdir</option> option to change where
383
460
        <term><filename>/var/run/mandos.pid</filename></term>
384
461
        <listitem>
385
462
          <para>
386
 
            The file containing the process id of
387
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
388
465
          </para>
389
466
        </listitem>
390
467
      </varlistentry>
418
495
      backtrace.  This could be considered a feature.
419
496
    </para>
420
497
    <para>
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.
 
498
      Currently, if a client is disabled due to having timed out, the
 
499
      server does not record this fact onto permanent storage.  This
 
500
      has some security implications, see <xref linkend="clients"/>.
430
501
    </para>
431
502
    <para>
432
503
      There is no fine-grained control over logging and debug output.
435
506
      Debug mode is conflated with running in the foreground.
436
507
    </para>
437
508
    <para>
438
 
      The console log messages does not show a time stamp.
 
509
      The console log messages do not show a time stamp.
439
510
    </para>
440
511
    <para>
441
512
      This server does not check the expire time of clients’ OpenPGP
483
554
  
484
555
  <refsect1 id="security">
485
556
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
557
    <refsect2 id="server">
487
558
      <title>SERVER</title>
488
559
      <para>
489
560
        Running this <command>&COMMANDNAME;</command> server program
492
563
        soon after startup.
493
564
      </para>
494
565
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
566
    <refsect2 id="clients">
496
567
      <title>CLIENTS</title>
497
568
      <para>
498
569
        The server only gives out its stored data to clients which
514
585
      </para>
515
586
      <para>
516
587
        If a client is compromised, its downtime should be duly noted
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.
 
588
        by the server which would therefore disable the client.  But
 
589
        if the server was ever restarted, it would re-read its client
 
590
        list from its configuration file and again regard all clients
 
591
        therein as enabled, and hence eligible to receive their
 
592
        passwords.  Therefore, be careful when restarting servers if
 
593
        it is suspected that a client has, in fact, been compromised
 
594
        by parties who may now be running a fake Mandos client with
 
595
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
596
        image of the client host.  What should be done in that case
 
597
        (if restarting the server program really is necessary) is to
 
598
        stop the server program, edit the configuration file to omit
 
599
        any suspect clients, and restart the server program.
530
600
      </para>
531
601
      <para>
532
602
        For more details on client-side security, see