/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-09-16 23:28:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090916232839-3o7i8qmcdcz5j1ya
* init.d-mandos (Required-Start, Required-Stop): Bug fix: Added
                 "$syslog", thanks to Petter Reinholdtsen
                 <pere@hungry.com> (Debian bug #546928).

* initramfs-tools-script: Removed erroneous comment.

* plugins.d/askpass-fifo.c: Removed TEMP_FAILURE_RETRY since it is
                            not needed.

* plugins.d/mandos-client.c (main): Bug fix: Initialize
                                    "old_sigterm_action".

* plugins.d/splashy.c (main): Bug fix: really check return value from
                              "sigaddset".  Fix some warnings on
                              64-bit systems.

* plugins.d/usplash.c (termination_handler, main): Save received
                                                   signal and
                                                   re-raise it on
                                                   exit.
  (usplash_write): Do not close FIFO, instead, take an additional file
                   descriptor pointer to it and open only when needed
                   (all callers changed).  Abort immediately on EINTR.
                   Bug fix:  Add NUL byte on single-word commands.
                   Ignore "interrupted_by_signal".
  (makeprompt, find_usplash): New; broken out from "main()".
  (find_usplash): Bug fix: close /proc/<pid>/cmdline FD on error.
  (main): Reorganized to jump to a new "failure" label on any error.
          Bug fix: check return values from sigaddset.
          New variable "usplash_accessed" to flag if usplash(8) needs
          to be killed and restarted.  Removed the "an_error_occured"
          variable.

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 "2011-08-08">
 
5
<!ENTITY TIMESTAMP "2009-09-10">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
36
      <holder>Teddy Hogeborn</holder>
39
37
      <holder>Björn Påhlsson</holder>
40
38
    </copyright>
88
86
      <sbr/>
89
87
      <arg><option>--debug</option></arg>
90
88
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
89
      <arg><option>--no-dbus</option></arg>
95
90
      <sbr/>
96
91
      <arg><option>--no-ipv6</option></arg>
199
194
      </varlistentry>
200
195
      
201
196
      <varlistentry>
202
 
        <term><option>--debuglevel
203
 
        <replaceable>LEVEL</replaceable></option></term>
204
 
        <listitem>
205
 
          <para>
206
 
            Set the debugging log level.
207
 
            <replaceable>LEVEL</replaceable> is a string, one of
208
 
            <quote><literal>CRITICAL</literal></quote>,
209
 
            <quote><literal>ERROR</literal></quote>,
210
 
            <quote><literal>WARNING</literal></quote>,
211
 
            <quote><literal>INFO</literal></quote>, or
212
 
            <quote><literal>DEBUG</literal></quote>, in order of
213
 
            increasing verbosity.  The default level is
214
 
            <quote><literal>WARNING</literal></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
197
        <term><option>--priority <replaceable>
221
198
        PRIORITY</replaceable></option></term>
222
199
        <listitem>
355
332
      checker program, and interval between checks can be configured
356
333
      both globally and per client; see <citerefentry>
357
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="approval">
365
 
    <title>APPROVAL</title>
366
 
    <para>
367
 
      The server can be configured to require manual approval for a
368
 
      client before it is sent its secret.  The delay to wait for such
369
 
      approval and the default action (approve or deny) can be
370
 
      configured both globally and per client; see <citerefentry>
371
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
372
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
373
 
      will be approved immediately without delay.
374
 
    </para>
375
 
    <para>
376
 
      This can be used to deny a client its secret if not manually
377
 
      approved within a specified time.  It can also be used to make
378
 
      the server delay before giving a client its secret, allowing
379
 
      optional manual denying of this specific client.
380
 
    </para>
381
 
    
 
335
      <manvolnum>5</manvolnum></citerefentry>.
 
336
    </para>
382
337
  </refsect1>
383
338
  
384
339
  <refsect1 id="logging">
396
351
    <para>
397
352
      The server will by default provide a D-Bus system bus interface.
398
353
      This interface will only be accessible by the root user or a
399
 
      Mandos-specific user, if such a user exists.  For documentation
400
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
354
      Mandos-specific user, if such a user exists.
 
355
      <!-- XXX -->
401
356
    </para>
402
357
  </refsect1>
403
358
  
461
416
        <term><filename>/var/run/mandos.pid</filename></term>
462
417
        <listitem>
463
418
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
419
            The file containing the process id of
 
420
            <command>&COMMANDNAME;</command>.
466
421
          </para>
467
422
        </listitem>
468
423
      </varlistentry>
496
451
      backtrace.  This could be considered a feature.
497
452
    </para>
498
453
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
 
454
      Currently, if a client is declared <quote>invalid</quote> due to
 
455
      having timed out, the server does not record this fact onto
 
456
      permanent storage.  This has some security implications, see
 
457
      <xref linkend="clients"/>.
 
458
    </para>
 
459
    <para>
 
460
      There is currently no way of querying the server of the current
 
461
      status of clients, other than analyzing its <systemitem
 
462
      class="service">syslog</systemitem> output.
502
463
    </para>
503
464
    <para>
504
465
      There is no fine-grained control over logging and debug output.
586
547
      </para>
587
548
      <para>
588
549
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
 
550
        by the server which would therefore declare the client
 
551
        invalid.  But if the server was ever restarted, it would
 
552
        re-read its client list from its configuration file and again
 
553
        regard all clients therein as valid, and hence eligible to
 
554
        receive their passwords.  Therefore, be careful when
 
555
        restarting servers if it is suspected that a client has, in
 
556
        fact, been compromised by parties who may now be running a
 
557
        fake Mandos client with the keys from the non-encrypted
 
558
        initial <acronym>RAM</acronym> image of the client host.  What
 
559
        should be done in that case (if restarting the server program
 
560
        really is necessary) is to stop the server program, edit the
 
561
        configuration file to omit any suspect clients, and restart
 
562
        the server program.
601
563
      </para>
602
564
      <para>
603
565
        For more details on client-side security, see
610
572
  <refsect1 id="see_also">
611
573
    <title>SEE ALSO</title>
612
574
    <para>
613
 
      <citerefentry><refentrytitle>intro</refentrytitle>
614
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
615
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
616
 
      <manvolnum>5</manvolnum></citerefentry>,
617
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
618
 
      <manvolnum>5</manvolnum></citerefentry>,
619
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
620
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>sh</refentrytitle>
622
 
      <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>
623
584
    </para>
624
585
    <variablelist>
625
586
      <varlistentry>