/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

Merge from trunk.  D-Bus usage is now standard, and there are two new
utilities (mandos-monitor and mandos-ctl) which uses it.  Also, a new
plugin for Plymouth.  Also fixes Debian bug #557076.

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 "2010-09-26">
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>
36
37
      <holder>Teddy Hogeborn</holder>
37
38
      <holder>Björn Påhlsson</holder>
38
39
    </copyright>
86
87
      <sbr/>
87
88
      <arg><option>--debug</option></arg>
88
89
      <sbr/>
 
90
      <arg><option>--debuglevel
 
91
      <replaceable>LEVEL</replaceable></option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--no-dbus</option></arg>
 
94
      <sbr/>
89
95
      <arg><option>--no-ipv6</option></arg>
90
96
    </cmdsynopsis>
91
97
    <cmdsynopsis>
192
198
      </varlistentry>
193
199
      
194
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>
195
219
        <term><option>--priority <replaceable>
196
220
        PRIORITY</replaceable></option></term>
197
221
        <listitem>
233
257
      </varlistentry>
234
258
      
235
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>
236
270
        <term><option>--no-ipv6</option></term>
237
271
        <listitem>
238
272
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
326
360
    </para>
327
361
  </refsect1>
328
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
    
 
381
  </refsect1>
 
382
  
329
383
  <refsect1 id="logging">
330
384
    <title>LOGGING</title>
331
385
    <para>
336
390
    </para>
337
391
  </refsect1>
338
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
  
339
403
  <refsect1 id="exit_status">
340
404
    <title>EXIT STATUS</title>
341
405
    <para>
396
460
        <term><filename>/var/run/mandos.pid</filename></term>
397
461
        <listitem>
398
462
          <para>
399
 
            The file containing the process id of
400
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
401
465
          </para>
402
466
        </listitem>
403
467
      </varlistentry>
431
495
      backtrace.  This could be considered a feature.
432
496
    </para>
433
497
    <para>
434
 
      Currently, if a client is declared <quote>invalid</quote> due to
435
 
      having timed out, the server does not record this fact onto
436
 
      permanent storage.  This has some security implications, see
437
 
      <xref linkend="clients"/>.
438
 
    </para>
439
 
    <para>
440
 
      There is currently no way of querying the server of the current
441
 
      status of clients, other than analyzing its <systemitem
442
 
      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"/>.
443
501
    </para>
444
502
    <para>
445
503
      There is no fine-grained control over logging and debug output.
527
585
      </para>
528
586
      <para>
529
587
        If a client is compromised, its downtime should be duly noted
530
 
        by the server which would therefore declare the client
531
 
        invalid.  But if the server was ever restarted, it would
532
 
        re-read its client list from its configuration file and again
533
 
        regard all clients therein as valid, and hence eligible to
534
 
        receive their passwords.  Therefore, be careful when
535
 
        restarting servers if it is suspected that a client has, in
536
 
        fact, been compromised by parties who may now be running a
537
 
        fake Mandos client with the keys from the non-encrypted
538
 
        initial <acronym>RAM</acronym> image of the client host.  What
539
 
        should be done in that case (if restarting the server program
540
 
        really is necessary) is to stop the server program, edit the
541
 
        configuration file to omit any suspect clients, and restart
542
 
        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.
543
600
      </para>
544
601
      <para>
545
602
        For more details on client-side security, see