/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-21 04:22:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921042250-r0qqjsbz2ulfo5le
* Makefile: Bug fix: fix syntax error.

* debian/control: Depend on "po-debconf".
  (mandos, mandos-client): Add "${misc:Depends}", used by
                           dh_installdebconf.

* debian/mandos-client.config: New; show note.
* debian/mandos-client.template: New.

* debian/mandos.README.Debian: New.

* debian/mandos.config: New; show note.
* debian/mandos.prerm: New; stop daemon.
* debian/mandos.template: New.

* debian/po/POTFILES.in: New.
* debian/po/sv.po: New.

* debian/rules (clean): Added "debconf-updatepo" as suggested by
                        po-debconf(7).
  (binary-common): Added "dh_installdebconf" to use "debian/*.config"
                   and "debian/*.template" files.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2009-09-17">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
85
83
      <replaceable>DIRECTORY</replaceable></option></arg>
86
84
      <sbr/>
87
85
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
86
    </cmdsynopsis>
93
87
    <cmdsynopsis>
94
88
      <command>&COMMANDNAME;</command>
233
227
          </para>
234
228
        </listitem>
235
229
      </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
230
    </variablelist>
254
231
  </refsect1>
255
232
  
327
304
      The server will, by default, continually check that the clients
328
305
      are still up.  If a client has not been confirmed as being up
329
306
      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,
 
307
      longer eligible to receive the encrypted password.  The timeout,
332
308
      checker program, and interval between checks can be configured
333
309
      both globally and per client; see <citerefentry>
334
310
      <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.
 
311
      <manvolnum>5</manvolnum></citerefentry>.
338
312
    </para>
339
313
  </refsect1>
340
314
  
348
322
    </para>
349
323
  </refsect1>
350
324
  
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
325
  <refsect1 id="exit_status">
362
326
    <title>EXIT STATUS</title>
363
327
    <para>
386
350
    </variablelist>
387
351
  </refsect1>
388
352
  
389
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
390
354
    <title>FILES</title>
391
355
    <para>
392
356
      Use the <option>--configdir</option> option to change where
456
420
      Currently, if a client is declared <quote>invalid</quote> due to
457
421
      having timed out, the server does not record this fact onto
458
422
      permanent storage.  This has some security implications, see
459
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
460
424
    </para>
461
425
    <para>
462
426
      There is currently no way of querying the server of the current
470
434
      Debug mode is conflated with running in the foreground.
471
435
    </para>
472
436
    <para>
473
 
      The console log messages do not show a time stamp.
 
437
      The console log messages does not show a time stamp.
474
438
    </para>
475
439
    <para>
476
440
      This server does not check the expire time of clients’ OpenPGP
518
482
  
519
483
  <refsect1 id="security">
520
484
    <title>SECURITY</title>
521
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
522
486
      <title>SERVER</title>
523
487
      <para>
524
488
        Running this <command>&COMMANDNAME;</command> server program
527
491
        soon after startup.
528
492
      </para>
529
493
    </refsect2>
530
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
531
495
      <title>CLIENTS</title>
532
496
      <para>
533
497
        The server only gives out its stored data to clients which
540
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
541
505
        <manvolnum>5</manvolnum></citerefentry>)
542
506
        <emphasis>must</emphasis> be made non-readable by anyone
543
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
544
508
      </para>
545
509
      <para>
546
510
        As detailed in <xref linkend="checking"/>, the status of all