/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

* debian/control (mandos-client): Conflict with correct version of
                                  dropbear.

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 "2009-09-17">
 
5
<!ENTITY TIMESTAMP "2011-02-27">
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>
36
38
      <holder>Teddy Hogeborn</holder>
37
39
      <holder>Björn Påhlsson</holder>
38
40
    </copyright>
86
88
      <sbr/>
87
89
      <arg><option>--debug</option></arg>
88
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
89
94
      <arg><option>--no-dbus</option></arg>
90
95
      <sbr/>
91
96
      <arg><option>--no-ipv6</option></arg>
194
199
      </varlistentry>
195
200
      
196
201
      <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>
197
220
        <term><option>--priority <replaceable>
198
221
        PRIORITY</replaceable></option></term>
199
222
        <listitem>
338
361
    </para>
339
362
  </refsect1>
340
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
    
 
382
  </refsect1>
 
383
  
341
384
  <refsect1 id="logging">
342
385
    <title>LOGGING</title>
343
386
    <para>
353
396
    <para>
354
397
      The server will by default provide a D-Bus system bus interface.
355
398
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.
357
 
      <!-- XXX -->
 
399
      Mandos-specific user, if such a user exists.  For documentation
 
400
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
401
    </para>
359
402
  </refsect1>
360
403
  
418
461
        <term><filename>/var/run/mandos.pid</filename></term>
419
462
        <listitem>
420
463
          <para>
421
 
            The file containing the process id of
422
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
423
466
          </para>
424
467
        </listitem>
425
468
      </varlistentry>
453
496
      backtrace.  This could be considered a feature.
454
497
    </para>
455
498
    <para>
456
 
      Currently, if a client is declared <quote>invalid</quote> due to
457
 
      having timed out, the server does not record this fact onto
458
 
      permanent storage.  This has some security implications, see
459
 
      <xref linkend="clients"/>.
460
 
    </para>
461
 
    <para>
462
 
      There is currently no way of querying the server of the current
463
 
      status of clients, other than analyzing its <systemitem
464
 
      class="service">syslog</systemitem> output.
 
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"/>.
465
502
    </para>
466
503
    <para>
467
504
      There is no fine-grained control over logging and debug output.
549
586
      </para>
550
587
      <para>
551
588
        If a client is compromised, its downtime should be duly noted
552
 
        by the server which would therefore declare the client
553
 
        invalid.  But if the server was ever restarted, it would
554
 
        re-read its client list from its configuration file and again
555
 
        regard all clients therein as valid, and hence eligible to
556
 
        receive their passwords.  Therefore, be careful when
557
 
        restarting servers if it is suspected that a client has, in
558
 
        fact, been compromised by parties who may now be running a
559
 
        fake Mandos client with the keys from the non-encrypted
560
 
        initial <acronym>RAM</acronym> image of the client host.  What
561
 
        should be done in that case (if restarting the server program
562
 
        really is necessary) is to stop the server program, edit the
563
 
        configuration file to omit any suspect clients, and restart
564
 
        the server program.
 
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.
565
601
      </para>
566
602
      <para>
567
603
        For more details on client-side security, see