/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: 2009-11-02 05:52:57 UTC
  • mfrom: (196.1.1 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20091102055257-orjjddrfrtw0jc9b
* mandos (Client.enable): Bug fix: Start new immediate checker last to
                          avoid race condition.
  (Client.disable): Optionally do not log message.
  (ClientDBus.disable): Do not log message if no signal should be sent.
  (string_to_delta): More informative error message.
  (main.cleanup): Emit D-Bus "ClientRemoved" signal for all clients.
                  Do not emit any other signal.  Move to after
                  "mandos_dbus_service" is defined.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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-09-30">
 
5
<!ENTITY TIMESTAMP "2009-09-17">
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>
35
36
      <holder>Teddy Hogeborn</holder>
36
37
      <holder>Björn Påhlsson</holder>
37
38
    </copyright>
84
85
      <replaceable>DIRECTORY</replaceable></option></arg>
85
86
      <sbr/>
86
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
87
92
    </cmdsynopsis>
88
93
    <cmdsynopsis>
89
94
      <command>&COMMANDNAME;</command>
228
233
          </para>
229
234
        </listitem>
230
235
      </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>
231
253
    </variablelist>
232
254
  </refsect1>
233
255
  
305
327
      The server will, by default, continually check that the clients
306
328
      are still up.  If a client has not been confirmed as being up
307
329
      for some time, the client is assumed to be compromised and is no
308
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
309
332
      checker program, and interval between checks can be configured
310
333
      both globally and per client; see <citerefentry>
311
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
312
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
313
338
    </para>
314
339
  </refsect1>
315
340
  
323
348
    </para>
324
349
  </refsect1>
325
350
  
 
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
  
326
361
  <refsect1 id="exit_status">
327
362
    <title>EXIT STATUS</title>
328
363
    <para>
351
386
    </variablelist>
352
387
  </refsect1>
353
388
  
354
 
  <refsect1 id="file">
 
389
  <refsect1 id="files">
355
390
    <title>FILES</title>
356
391
    <para>
357
392
      Use the <option>--configdir</option> option to change where
421
456
      Currently, if a client is declared <quote>invalid</quote> due to
422
457
      having timed out, the server does not record this fact onto
423
458
      permanent storage.  This has some security implications, see
424
 
      <xref linkend="CLIENTS"/>.
 
459
      <xref linkend="clients"/>.
425
460
    </para>
426
461
    <para>
427
462
      There is currently no way of querying the server of the current
435
470
      Debug mode is conflated with running in the foreground.
436
471
    </para>
437
472
    <para>
438
 
      The console log messages does not show a time stamp.
 
473
      The console log messages do not show a time stamp.
439
474
    </para>
440
475
    <para>
441
476
      This server does not check the expire time of clients’ OpenPGP
483
518
  
484
519
  <refsect1 id="security">
485
520
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
521
    <refsect2 id="server">
487
522
      <title>SERVER</title>
488
523
      <para>
489
524
        Running this <command>&COMMANDNAME;</command> server program
492
527
        soon after startup.
493
528
      </para>
494
529
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
530
    <refsect2 id="clients">
496
531
      <title>CLIENTS</title>
497
532
      <para>
498
533
        The server only gives out its stored data to clients which