/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 18:59:44 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930185944-zjw2s8bsw4gmww7d
* Makefile (uninstall-client): Do not remove obsolete README file.

* debian/rules: Do not change permissions on "/etc/mandos/plugins.d".

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-10">
 
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>
346
323
    </para>
347
324
  </refsect1>
348
325
  
349
 
  <refsect1 id="dbus_interface">
350
 
    <title>D-BUS INTERFACE</title>
351
 
    <para>
352
 
      The server will by default provide a D-Bus system bus interface.
353
 
      This interface will only be accessible by the root user or a
354
 
      Mandos-specific user, if such a user exists.
355
 
      <!-- XXX -->
356
 
    </para>
357
 
  </refsect1>
358
 
  
359
326
  <refsect1 id="exit_status">
360
327
    <title>EXIT STATUS</title>
361
328
    <para>
384
351
    </variablelist>
385
352
  </refsect1>
386
353
  
387
 
  <refsect1 id="files">
 
354
  <refsect1 id="file">
388
355
    <title>FILES</title>
389
356
    <para>
390
357
      Use the <option>--configdir</option> option to change where
454
421
      Currently, if a client is declared <quote>invalid</quote> due to
455
422
      having timed out, the server does not record this fact onto
456
423
      permanent storage.  This has some security implications, see
457
 
      <xref linkend="clients"/>.
 
424
      <xref linkend="CLIENTS"/>.
458
425
    </para>
459
426
    <para>
460
427
      There is currently no way of querying the server of the current
468
435
      Debug mode is conflated with running in the foreground.
469
436
    </para>
470
437
    <para>
471
 
      The console log messages do not show a time stamp.
 
438
      The console log messages does not show a time stamp.
472
439
    </para>
473
440
    <para>
474
441
      This server does not check the expire time of clients’ OpenPGP
516
483
  
517
484
  <refsect1 id="security">
518
485
    <title>SECURITY</title>
519
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
520
487
      <title>SERVER</title>
521
488
      <para>
522
489
        Running this <command>&COMMANDNAME;</command> server program
525
492
        soon after startup.
526
493
      </para>
527
494
    </refsect2>
528
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
529
496
      <title>CLIENTS</title>
530
497
      <para>
531
498
        The server only gives out its stored data to clients which