/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: 2008-09-30 07:23:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930072339-jn15gyrtfpdk2dhx
* .bzrignore: Added "man" directory (created by "make install-html").

* Makefile: Add "common.ent" dependency to all manual pages.
  (htmldir, version, SED): New variables.
  (CFLAGS): Add -D option to define VERSION to $(version).
  (MANPOST, HTMLPOST): Use $(SED).
  (PROGS): Use $(CPROGS)
  (CPROGS): New; C-only programs.
  (objects): Use $(CPROGS).
  (common.ent, mandos, mandos-keygen): New targets; update version
                                       number to $(version).
  (clean): Use $(CPROGS).
  (check): Depend on "all".
  (install-html): Install to $(htmldir).

* common.ent: New file with "version" entity.

* mandos-clients.conf.xml: Use "common.ent".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.xml: - '' -

* plugin-runner.c (argp_program_version): Use VERSION.
* plugins.d/mandos-client.c (argp_program_version): - '' -
* plugins.d/password-prompt.c (argp_program_version): - '' -

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-12-09">
 
5
<!ENTITY TIMESTAMP "2008-09-30">
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
35
      <holder>Teddy Hogeborn</holder>
37
36
      <holder>Björn Påhlsson</holder>
38
37
    </copyright>
85
84
      <replaceable>DIRECTORY</replaceable></option></arg>
86
85
      <sbr/>
87
86
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
87
    </cmdsynopsis>
93
88
    <cmdsynopsis>
94
89
      <command>&COMMANDNAME;</command>
233
228
          </para>
234
229
        </listitem>
235
230
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
231
    </variablelist>
254
232
  </refsect1>
255
233
  
327
305
      The server will, by default, continually check that the clients
328
306
      are still up.  If a client has not been confirmed as being up
329
307
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
308
      longer eligible to receive the encrypted password.  The timeout,
332
309
      checker program, and interval between checks can be configured
333
310
      both globally and per client; see <citerefentry>
334
311
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
 
312
      <manvolnum>5</manvolnum></citerefentry>.
338
313
    </para>
339
314
  </refsect1>
340
315
  
348
323
    </para>
349
324
  </refsect1>
350
325
  
351
 
  <refsect1 id="dbus_interface">
352
 
    <title>D-BUS INTERFACE</title>
353
 
    <para>
354
 
      The server will by default provide a D-Bus system bus interface.
355
 
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.
357
 
      <!-- XXX -->
358
 
    </para>
359
 
  </refsect1>
360
 
  
361
326
  <refsect1 id="exit_status">
362
327
    <title>EXIT STATUS</title>
363
328
    <para>
386
351
    </variablelist>
387
352
  </refsect1>
388
353
  
389
 
  <refsect1 id="files">
 
354
  <refsect1 id="file">
390
355
    <title>FILES</title>
391
356
    <para>
392
357
      Use the <option>--configdir</option> option to change where
453
418
      backtrace.  This could be considered a feature.
454
419
    </para>
455
420
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
 
421
      Currently, if a client is declared <quote>invalid</quote> due to
 
422
      having timed out, the server does not record this fact onto
 
423
      permanent storage.  This has some security implications, see
 
424
      <xref linkend="CLIENTS"/>.
459
425
    </para>
460
426
    <para>
461
427
      There is currently no way of querying the server of the current
469
435
      Debug mode is conflated with running in the foreground.
470
436
    </para>
471
437
    <para>
472
 
      The console log messages do not show a time stamp.
 
438
      The console log messages does not show a time stamp.
473
439
    </para>
474
440
    <para>
475
441
      This server does not check the expire time of clients’ OpenPGP
517
483
  
518
484
  <refsect1 id="security">
519
485
    <title>SECURITY</title>
520
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
521
487
      <title>SERVER</title>
522
488
      <para>
523
489
        Running this <command>&COMMANDNAME;</command> server program
526
492
        soon after startup.
527
493
      </para>
528
494
    </refsect2>
529
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
530
496
      <title>CLIENTS</title>
531
497
      <para>
532
498
        The server only gives out its stored data to clients which
548
514
      </para>
549
515
      <para>
550
516
        If a client is compromised, its downtime should be duly noted
551
 
        by the server which would therefore disable the client.  But
552
 
        if the server was ever restarted, it would re-read its client
553
 
        list from its configuration file and again regard all clients
554
 
        therein as enabled, and hence eligible to receive their
555
 
        passwords.  Therefore, be careful when restarting servers if
556
 
        it is suspected that a client has, in fact, been compromised
557
 
        by parties who may now be running a fake Mandos client with
558
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
559
 
        image of the client host.  What should be done in that case
560
 
        (if restarting the server program really is necessary) is to
561
 
        stop the server program, edit the configuration file to omit
562
 
        any suspect clients, and restart the server program.
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial <acronym>RAM</acronym> image of the client host.  What
 
526
        should be done in that case (if restarting the server program
 
527
        really is necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
563
530
      </para>
564
531
      <para>
565
532
        For more details on client-side security, see