/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-17 00:34:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080917003409-bxbjsc4o69nx40t6
* .bzr-builddeb/default.conf: New.

* Makefile (install-server): Do not create directories that
                             should already be present in a
                             normal system.
  (install-client-nokey): - '' -  Also specify non-executable
                          mode for "initramfs-tools-hook-conf".

* README: Improved wording.  Use real copyright mark.

* debian/changelog: New.
* debian/compat: - '' -
* debian/control: - '' -
* debian/copyright: - '' -
* debian/mandos-client.README.Debian: - '' -
* debian/mandos-client.dirs: - '' -
* debian/mandos-client.lintian-overrides: - '' -
* debian/mandos-client.postinst: - '' -
* debian/mandos-client.postrm: - '' -
* debian/mandos.dirs: - '' -
* debian/mandos.lintian-overrides: - '' -
* debian/rules: - '' -
* default-mandos: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-10">
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>
346
322
    </para>
347
323
  </refsect1>
348
324
  
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
325
  <refsect1 id="exit_status">
360
326
    <title>EXIT STATUS</title>
361
327
    <para>
384
350
    </variablelist>
385
351
  </refsect1>
386
352
  
387
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
388
354
    <title>FILES</title>
389
355
    <para>
390
356
      Use the <option>--configdir</option> option to change where
454
420
      Currently, if a client is declared <quote>invalid</quote> due to
455
421
      having timed out, the server does not record this fact onto
456
422
      permanent storage.  This has some security implications, see
457
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
458
424
    </para>
459
425
    <para>
460
426
      There is currently no way of querying the server of the current
468
434
      Debug mode is conflated with running in the foreground.
469
435
    </para>
470
436
    <para>
471
 
      The console log messages do not show a time stamp.
 
437
      The console log messages does not show a time stamp.
472
438
    </para>
473
439
    <para>
474
440
      This server does not check the expire time of clients’ OpenPGP
516
482
  
517
483
  <refsect1 id="security">
518
484
    <title>SECURITY</title>
519
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
520
486
      <title>SERVER</title>
521
487
      <para>
522
488
        Running this <command>&COMMANDNAME;</command> server program
525
491
        soon after startup.
526
492
      </para>
527
493
    </refsect2>
528
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
529
495
      <title>CLIENTS</title>
530
496
      <para>
531
497
        The server only gives out its stored data to clients which
538
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
539
505
        <manvolnum>5</manvolnum></citerefentry>)
540
506
        <emphasis>must</emphasis> be made non-readable by anyone
541
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
542
508
      </para>
543
509
      <para>
544
510
        As detailed in <xref linkend="checking"/>, the status of all