/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-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-08 12:03:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908120316-rrt6r0a5yezc3q1d
* INSTALL: New file.

* mandos-keygen: Use "/etc/mandos/keys" if "/etc/keys/mandos" does not
                 exist.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.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 CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-12-09">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-09-04">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
38
    <xi:include href="legalnotice.xml"/>
41
39
  </refentryinfo>
42
 
  
 
40
 
43
41
  <refmeta>
44
42
    <refentrytitle>&CONFNAME;</refentrytitle>
45
43
    <manvolnum>5</manvolnum>
51
49
      Configuration file for the Mandos server
52
50
    </refpurpose>
53
51
  </refnamediv>
54
 
  
 
52
 
55
53
  <refsynopsisdiv>
56
54
    <synopsis>&CONFPATH;</synopsis>
57
55
  </refsynopsisdiv>
58
 
  
 
56
 
59
57
  <refsect1 id="description">
60
58
    <title>DESCRIPTION</title>
61
59
    <para>
63
61
      ><refentrytitle>mandos</refentrytitle>
64
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
63
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
64
      the service.  All clients listed will be regarded as valid, even
 
65
      if a client was declared invalid in a previous run of the
 
66
      server.
68
67
    </para>
69
68
    <para>
70
69
      The format starts with a <literal>[<replaceable>section
96
95
    <para>
97
96
      Unknown options are ignored.  The used options are as follows:
98
97
    </para>
99
 
    
 
98
 
100
99
    <variablelist>
101
 
      
 
100
 
102
101
      <varlistentry>
103
102
        <term><option>timeout<literal> = </literal><replaceable
104
103
        >TIME</replaceable></option></term>
107
106
            This option is <emphasis>optional</emphasis>.
108
107
          </para>
109
108
          <para>
110
 
            The timeout is how long the server will wait (for either a
111
 
            successful checker run or a client receiving its secret)
112
 
            until a client is disabled and not allowed to get the data
113
 
            this server holds.  By default Mandos will use 1 hour.
 
109
            The timeout is how long the server will wait for a
 
110
            successful checker run until a client is considered
 
111
            invalid - that is, ineligible to get the data this server
 
112
            holds.  By default Mandos will use 1 hour.
114
113
          </para>
115
114
          <para>
116
115
            The <replaceable>TIME</replaceable> is specified as a
127
126
          </para>
128
127
        </listitem>
129
128
      </varlistentry>
130
 
      
 
129
 
131
130
      <varlistentry>
132
131
        <term><option>interval<literal> = </literal><replaceable
133
132
        >TIME</replaceable></option></term>
141
140
            not be started if an old one is still running.  The server
142
141
            will wait for a checker to complete until the above
143
142
            <quote><varname>timeout</varname></quote> occurs, at which
144
 
            time the client will be disabled, and any running checker
145
 
            killed.  The default interval is 5 minutes.
 
143
            time the client will be marked invalid, and any running
 
144
            checker killed.  The default interval is 5 minutes.
146
145
          </para>
147
146
          <para>
148
147
            The format of <replaceable>TIME</replaceable> is the same
150
149
          </para>
151
150
        </listitem>
152
151
      </varlistentry>
153
 
      
 
152
 
154
153
      <varlistentry>
155
154
        <term><option>checker<literal> = </literal><replaceable
156
155
        >COMMAND</replaceable></option></term>
169
168
            <varname>PATH</varname> will be searched.  The default
170
169
            value for the checker command is <quote><literal
171
170
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
171
            >--</option> %(host)s</literal></quote>.
173
172
          </para>
174
173
          <para>
175
174
            In addition to normal start time expansion, this option
224
223
          </para>
225
224
        </listitem>
226
225
      </varlistentry>
227
 
      
 
226
 
228
227
      <varlistentry>
229
228
        <term><option>secfile<literal> = </literal><replaceable
230
229
        >FILENAME</replaceable></option></term>
240
239
            should <emphasis>not</emphasis> be base64-encoded, but
241
240
            will be sent to clients verbatim.
242
241
          </para>
243
 
          <para>
244
 
            File names of the form <filename>~user/foo/bar</filename>
245
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
246
 
            are supported.
247
 
          </para>
248
242
        </listitem>
249
243
      </varlistentry>
250
 
      
 
244
 
251
245
      <varlistentry>
252
246
        <term><option><literal>host = </literal><replaceable
253
247
        >STRING</replaceable></option></term>
256
250
            This option is <emphasis>optional</emphasis>, but highly
257
251
            <emphasis>recommended</emphasis> unless the
258
252
            <option>checker</option> option is modified to a
259
 
            non-standard value without <quote>%%(host)s</quote> in it.
 
253
            non-standard value without <quote>%(host)s</quote> in it.
260
254
          </para>
261
255
          <para>
262
256
            Host name for this client.  This is not used by the server
319
313
        mode is needed to expose an error of this kind.
320
314
      </para>
321
315
    </refsect2>
322
 
    
 
316
 
323
317
  </refsect1>
324
318
  
325
319
  <refsect1 id="files">
350
344
[DEFAULT]
351
345
timeout = 1h
352
346
interval = 5m
353
 
checker = fping -q -- %%(host)s
 
347
checker = fping -q -- %(host)s
354
348
 
355
349
# Client "foo"
356
350
[foo]
379
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
374
secfile = /etc/mandos/bar-secret
381
375
timeout = 15m
 
376
 
382
377
      </programlisting>
383
378
    </informalexample>
384
379
  </refsect1>