/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 at bsnet
  • Date: 2010-09-27 17:39:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927173903-9s5e6a3hl5iswmp7
* mandos: Fixed "--help" output.
* mandos.xml (SYNOPSIS, OPTIONS): Document new option "--debuglevel".

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-12-28">
 
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>
85
87
      <sbr/>
86
88
      <arg><option>--debug</option></arg>
87
89
      <sbr/>
 
90
      <arg><option>--debuglevel
 
91
      <replaceable>LEVEL</replaceable></option></arg>
 
92
      <sbr/>
88
93
      <arg><option>--no-dbus</option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-ipv6</option></arg>
89
96
    </cmdsynopsis>
90
97
    <cmdsynopsis>
91
98
      <command>&COMMANDNAME;</command>
191
198
      </varlistentry>
192
199
      
193
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>
194
219
        <term><option>--priority <replaceable>
195
220
        PRIORITY</replaceable></option></term>
196
221
        <listitem>
236
261
        <listitem>
237
262
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
263
          <para>
239
 
            See also <xref linkend="dbus"/>.
 
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"/>
240
273
        </listitem>
241
274
      </varlistentry>
242
275
    </variablelist>
316
349
      The server will, by default, continually check that the clients
317
350
      are still up.  If a client has not been confirmed as being up
318
351
      for some time, the client is assumed to be compromised and is no
319
 
      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,
320
354
      checker program, and interval between checks can be configured
321
355
      both globally and per client; see <citerefentry>
322
356
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.
324
 
    </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
    
325
381
  </refsect1>
326
382
  
327
383
  <refsect1 id="logging">
334
390
    </para>
335
391
  </refsect1>
336
392
  
337
 
  <refsect1 id="dbus">
 
393
  <refsect1 id="dbus_interface">
338
394
    <title>D-BUS INTERFACE</title>
339
395
    <para>
340
396
      The server will by default provide a D-Bus system bus interface.
341
397
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
 
398
      Mandos-specific user, if such a user exists.  For documentation
 
399
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
344
400
    </para>
345
401
  </refsect1>
346
 
 
 
402
  
347
403
  <refsect1 id="exit_status">
348
404
    <title>EXIT STATUS</title>
349
405
    <para>
404
460
        <term><filename>/var/run/mandos.pid</filename></term>
405
461
        <listitem>
406
462
          <para>
407
 
            The file containing the process id of
408
 
            <command>&COMMANDNAME;</command>.
 
463
            The file containing the process id of the
 
464
            <command>&COMMANDNAME;</command> process started last.
409
465
          </para>
410
466
        </listitem>
411
467
      </varlistentry>
439
495
      backtrace.  This could be considered a feature.
440
496
    </para>
441
497
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      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"/>.
451
501
    </para>
452
502
    <para>
453
503
      There is no fine-grained control over logging and debug output.
456
506
      Debug mode is conflated with running in the foreground.
457
507
    </para>
458
508
    <para>
459
 
      The console log messages does not show a time stamp.
 
509
      The console log messages do not show a time stamp.
460
510
    </para>
461
511
    <para>
462
512
      This server does not check the expire time of clients’ OpenPGP
535
585
      </para>
536
586
      <para>
537
587
        If a client is compromised, its downtime should be duly noted
538
 
        by the server which would therefore declare the client
539
 
        invalid.  But if the server was ever restarted, it would
540
 
        re-read its client list from its configuration file and again
541
 
        regard all clients therein as valid, and hence eligible to
542
 
        receive their passwords.  Therefore, be careful when
543
 
        restarting servers if it is suspected that a client has, in
544
 
        fact, been compromised by parties who may now be running a
545
 
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
549
 
        configuration file to omit any suspect clients, and restart
550
 
        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.
551
600
      </para>
552
601
      <para>
553
602
        For more details on client-side security, see