/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-10-01 18:41:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001184106-r728au6iv0lq8orm
Tags: version-1.0-2
* debian/changelog: Add Debian revision number to old revision too.

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 "2009-09-17">
 
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
456
421
      Currently, if a client is declared <quote>invalid</quote> due to
457
422
      having timed out, the server does not record this fact onto
458
423
      permanent storage.  This has some security implications, see
459
 
      <xref linkend="clients"/>.
 
424
      <xref linkend="CLIENTS"/>.
460
425
    </para>
461
426
    <para>
462
427
      There is currently no way of querying the server of the current
470
435
      Debug mode is conflated with running in the foreground.
471
436
    </para>
472
437
    <para>
473
 
      The console log messages do not show a time stamp.
 
438
      The console log messages does not show a time stamp.
474
439
    </para>
475
440
    <para>
476
441
      This server does not check the expire time of clients’ OpenPGP
518
483
  
519
484
  <refsect1 id="security">
520
485
    <title>SECURITY</title>
521
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
522
487
      <title>SERVER</title>
523
488
      <para>
524
489
        Running this <command>&COMMANDNAME;</command> server program
527
492
        soon after startup.
528
493
      </para>
529
494
    </refsect2>
530
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
531
496
      <title>CLIENTS</title>
532
497
      <para>
533
498
        The server only gives out its stored data to clients which