/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

* debian/mandos.dirs: Added "etc/dbus-1/system.d".

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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-03">
 
6
<!ENTITY TIMESTAMP "2010-09-12">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
38
40
    <xi:include href="legalnotice.xml"/>
39
41
  </refentryinfo>
40
 
 
 
42
  
41
43
  <refmeta>
42
44
    <refentrytitle>&CONFNAME;</refentrytitle>
43
45
    <manvolnum>5</manvolnum>
49
51
      Configuration file for the Mandos server
50
52
    </refpurpose>
51
53
  </refnamediv>
52
 
 
 
54
  
53
55
  <refsynopsisdiv>
54
56
    <synopsis>&CONFPATH;</synopsis>
55
57
  </refsynopsisdiv>
56
 
 
 
58
  
57
59
  <refsect1 id="description">
58
60
    <title>DESCRIPTION</title>
59
61
    <para>
61
63
      ><refentrytitle>mandos</refentrytitle>
62
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
65
      The file needs to list all clients that should be able to use
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.
 
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.
67
68
    </para>
68
69
    <para>
69
70
      The format starts with a <literal>[<replaceable>section
93
94
      start time expansion, see <xref linkend="expansion"/>.
94
95
    </para>
95
96
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
97
      Unknown options are ignored.  The used options are as follows:
97
98
    </para>
98
 
 
 
99
    
99
100
    <variablelist>
100
 
 
 
101
      
101
102
      <varlistentry>
102
103
        <term><option>timeout<literal> = </literal><replaceable
103
104
        >TIME</replaceable></option></term>
106
107
            This option is <emphasis>optional</emphasis>.
107
108
          </para>
108
109
          <para>
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.
 
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.
113
114
          </para>
114
115
          <para>
115
116
            The <replaceable>TIME</replaceable> is specified as a
126
127
          </para>
127
128
        </listitem>
128
129
      </varlistentry>
129
 
 
 
130
      
130
131
      <varlistentry>
131
132
        <term><option>interval<literal> = </literal><replaceable
132
133
        >TIME</replaceable></option></term>
140
141
            not be started if an old one is still running.  The server
141
142
            will wait for a checker to complete until the above
142
143
            <quote><varname>timeout</varname></quote> occurs, at which
143
 
            time the client will be marked invalid, and any running
144
 
            checker killed.  The default interval is 5 minutes.
 
144
            time the client will be disabled, and any running checker
 
145
            killed.  The default interval is 5 minutes.
145
146
          </para>
146
147
          <para>
147
148
            The format of <replaceable>TIME</replaceable> is the same
149
150
          </para>
150
151
        </listitem>
151
152
      </varlistentry>
152
 
 
 
153
      
153
154
      <varlistentry>
154
155
        <term><option>checker<literal> = </literal><replaceable
155
156
        >COMMAND</replaceable></option></term>
168
169
            <varname>PATH</varname> will be searched.  The default
169
170
            value for the checker command is <quote><literal
170
171
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
172
            >--</option> %%(host)s</literal></quote>.
172
173
          </para>
173
174
          <para>
174
175
            In addition to normal start time expansion, this option
223
224
          </para>
224
225
        </listitem>
225
226
      </varlistentry>
226
 
 
 
227
      
227
228
      <varlistentry>
228
229
        <term><option>secfile<literal> = </literal><replaceable
229
230
        >FILENAME</replaceable></option></term>
239
240
            should <emphasis>not</emphasis> be base64-encoded, but
240
241
            will be sent to clients verbatim.
241
242
          </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>
242
248
        </listitem>
243
249
      </varlistentry>
244
 
 
 
250
      
245
251
      <varlistentry>
246
252
        <term><option><literal>host = </literal><replaceable
247
253
        >STRING</replaceable></option></term>
250
256
            This option is <emphasis>optional</emphasis>, but highly
251
257
            <emphasis>recommended</emphasis> unless the
252
258
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
 
259
            non-standard value without <quote>%%(host)s</quote> in it.
254
260
          </para>
255
261
          <para>
256
262
            Host name for this client.  This is not used by the server
260
266
        </listitem>
261
267
      </varlistentry>
262
268
      
 
269
      <varlistentry>
 
270
        <term><option>approved_by_default<literal> = </literal
 
271
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
272
          >true</literal> | <literal>on</literal> | <literal
 
273
          >0</literal> | <literal>no</literal> | <literal
 
274
          >false</literal> | <literal>off</literal> }</option></term>
 
275
        <listitem>
 
276
          <para>
 
277
            Whether to approve a client by default after
 
278
            the <option>approval_delay</option>.  The default
 
279
            is <quote>True</quote>.
 
280
          </para>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>approval_delay<literal> = </literal><replaceable
 
286
        >TIME</replaceable></option></term>
 
287
        <listitem>
 
288
          <para>
 
289
            This option is <emphasis>optional</emphasis>.
 
290
          </para>
 
291
          <para>
 
292
            How long to wait for external approval before resorting to
 
293
            use the <option>approved_by_default</option> value.  The
 
294
            default is <quote>0s</quote>, i.e. not to wait.
 
295
          </para>
 
296
          <para>
 
297
            The format of <replaceable>TIME</replaceable> is the same
 
298
            as for <varname>timeout</varname> above.
 
299
          </para>
 
300
        </listitem>
 
301
      </varlistentry>
 
302
      
 
303
      <varlistentry>
 
304
        <term><option>approval_duration<literal> = </literal
 
305
        ><replaceable>TIME</replaceable></option></term>
 
306
        <listitem>
 
307
          <para>
 
308
            This option is <emphasis>optional</emphasis>.
 
309
          </para>
 
310
          <para>
 
311
            How long an external approval lasts.  The default is 1
 
312
            second.
 
313
          </para>
 
314
          <para>
 
315
            The format of <replaceable>TIME</replaceable> is the same
 
316
            as for <varname>timeout</varname> above.
 
317
          </para>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
263
321
    </variablelist>
264
322
  </refsect1>
265
323
  
313
371
        mode is needed to expose an error of this kind.
314
372
      </para>
315
373
    </refsect2>
316
 
 
 
374
    
317
375
  </refsect1>
318
376
  
319
377
  <refsect1 id="files">
344
402
[DEFAULT]
345
403
timeout = 1h
346
404
interval = 5m
347
 
checker = fping -q -- %(host)s
 
405
checker = fping -q -- %%(host)s
348
406
 
349
407
# Client "foo"
350
408
[foo]
373
431
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
432
secfile = /etc/mandos/bar-secret
375
433
timeout = 15m
376
 
 
 
434
approved_by_default = False
 
435
approval_delay = 30s
377
436
      </programlisting>
378
437
    </informalexample>
379
438
  </refsect1>