/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: 2011-08-17 22:27:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110817222713-xemqfzafjciuaqkz
* mandos-keygen: Loop until passwords match when run interactively.

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-01-04">
 
5
<!ENTITY TIMESTAMP "2011-08-08">
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>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
90
97
    </cmdsynopsis>
91
98
    <cmdsynopsis>
92
99
      <command>&COMMANDNAME;</command>
192
199
      </varlistentry>
193
200
      
194
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>
195
220
        <term><option>--priority <replaceable>
196
221
        PRIORITY</replaceable></option></term>
197
222
        <listitem>
241
266
          </para>
242
267
        </listitem>
243
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>--no-ipv6</option></term>
 
272
        <listitem>
 
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
274
        </listitem>
 
275
      </varlistentry>
244
276
    </variablelist>
245
277
  </refsect1>
246
278
  
318
350
      The server will, by default, continually check that the clients
319
351
      are still up.  If a client has not been confirmed as being up
320
352
      for some time, the client is assumed to be compromised and is no
321
 
      longer eligible to receive the encrypted password.  The timeout,
 
353
      longer eligible to receive the encrypted password.  (Manual
 
354
      intervention is required to re-enable a client.)  The timeout,
322
355
      checker program, and interval between checks can be configured
323
356
      both globally and per client; see <citerefentry>
324
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
325
 
      <manvolnum>5</manvolnum></citerefentry>.
326
 
    </para>
 
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
    
327
382
  </refsect1>
328
383
  
329
384
  <refsect1 id="logging">
341
396
    <para>
342
397
      The server will by default provide a D-Bus system bus interface.
343
398
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- 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>.
346
401
    </para>
347
402
  </refsect1>
348
 
 
 
403
  
349
404
  <refsect1 id="exit_status">
350
405
    <title>EXIT STATUS</title>
351
406
    <para>
406
461
        <term><filename>/var/run/mandos.pid</filename></term>
407
462
        <listitem>
408
463
          <para>
409
 
            The file containing the process id of
410
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
411
466
          </para>
412
467
        </listitem>
413
468
      </varlistentry>
441
496
      backtrace.  This could be considered a feature.
442
497
    </para>
443
498
    <para>
444
 
      Currently, if a client is declared <quote>invalid</quote> due to
445
 
      having timed out, the server does not record this fact onto
446
 
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
448
 
    </para>
449
 
    <para>
450
 
      There is currently no way of querying the server of the current
451
 
      status of clients, other than analyzing its <systemitem
452
 
      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"/>.
453
502
    </para>
454
503
    <para>
455
504
      There is no fine-grained control over logging and debug output.
458
507
      Debug mode is conflated with running in the foreground.
459
508
    </para>
460
509
    <para>
461
 
      The console log messages does not show a time stamp.
 
510
      The console log messages do not show a time stamp.
462
511
    </para>
463
512
    <para>
464
513
      This server does not check the expire time of clients’ OpenPGP
537
586
      </para>
538
587
      <para>
539
588
        If a client is compromised, its downtime should be duly noted
540
 
        by the server which would therefore declare the client
541
 
        invalid.  But if the server was ever restarted, it would
542
 
        re-read its client list from its configuration file and again
543
 
        regard all clients therein as valid, and hence eligible to
544
 
        receive their passwords.  Therefore, be careful when
545
 
        restarting servers if it is suspected that a client has, in
546
 
        fact, been compromised by parties who may now be running a
547
 
        fake Mandos client with the keys from the non-encrypted
548
 
        initial <acronym>RAM</acronym> image of the client host.  What
549
 
        should be done in that case (if restarting the server program
550
 
        really is necessary) is to stop the server program, edit the
551
 
        configuration file to omit any suspect clients, and restart
552
 
        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.
553
601
      </para>
554
602
      <para>
555
603
        For more details on client-side security, see
562
610
  <refsect1 id="see_also">
563
611
    <title>SEE ALSO</title>
564
612
    <para>
565
 
      <citerefentry>
566
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos.conf</refentrytitle>
569
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>mandos-client</refentrytitle>
571
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
 
      </citerefentry>
 
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>
574
623
    </para>
575
624
    <variablelist>
576
625
      <varlistentry>