/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

Merge threading/seg fault fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-12-09">
 
6
<!ENTITY TIMESTAMP "2011-11-26">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
37
39
      <holder>Teddy Hogeborn</holder>
38
40
      <holder>Björn Påhlsson</holder>
39
41
    </copyright>
100
102
    <variablelist>
101
103
      
102
104
      <varlistentry>
103
 
        <term><option>timeout<literal> = </literal><replaceable
104
 
        >TIME</replaceable></option></term>
105
 
        <listitem>
106
 
          <para>
107
 
            This option is <emphasis>optional</emphasis>.
108
 
          </para>
109
 
          <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.
114
 
          </para>
115
 
          <para>
116
 
            The <replaceable>TIME</replaceable> is specified as a
117
 
            space-separated number of values, each of which is a
118
 
            number and a one-character suffix.  The suffix must be one
119
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
120
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
121
 
            minutes, hours, and weeks, respectively.  The values are
122
 
            added together to give the total time value, so all of
123
 
            <quote><literal>330s</literal></quote>,
124
 
            <quote><literal>110s 110s 110s</literal></quote>, and
125
 
            <quote><literal>5m 30s</literal></quote> will give a value
126
 
            of five minutes and thirty seconds.
127
 
          </para>
128
 
        </listitem>
129
 
      </varlistentry>
130
 
      
131
 
      <varlistentry>
132
 
        <term><option>interval<literal> = </literal><replaceable
133
 
        >TIME</replaceable></option></term>
134
 
        <listitem>
135
 
          <para>
136
 
            This option is <emphasis>optional</emphasis>.
137
 
          </para>
138
 
          <para>
139
 
            How often to run the checker to confirm that a client is
140
 
            still up.  <emphasis>Note:</emphasis> a new checker will
141
 
            not be started if an old one is still running.  The server
142
 
            will wait for a checker to complete until the above
143
 
            <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.
146
 
          </para>
147
 
          <para>
148
 
            The format of <replaceable>TIME</replaceable> is the same
149
 
            as for <varname>timeout</varname> above.
 
105
        <term><option>approval_delay<literal> = </literal><replaceable
 
106
        >TIME</replaceable></option></term>
 
107
        <listitem>
 
108
          <para>
 
109
            This option is <emphasis>optional</emphasis>.
 
110
          </para>
 
111
          <para>
 
112
            How long to wait for external approval before resorting to
 
113
            use the <option>approved_by_default</option> value.  The
 
114
            default is <quote>0s</quote>, i.e. not to wait.
 
115
          </para>
 
116
          <para>
 
117
            The format of <replaceable>TIME</replaceable> is the same
 
118
            as for <varname>timeout</varname> below.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
      
 
123
      <varlistentry>
 
124
        <term><option>approval_duration<literal> = </literal
 
125
        ><replaceable>TIME</replaceable></option></term>
 
126
        <listitem>
 
127
          <para>
 
128
            This option is <emphasis>optional</emphasis>.
 
129
          </para>
 
130
          <para>
 
131
            How long an external approval lasts.  The default is 1
 
132
            second.
 
133
          </para>
 
134
          <para>
 
135
            The format of <replaceable>TIME</replaceable> is the same
 
136
            as for <varname>timeout</varname> below.
 
137
          </para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
      
 
141
      <varlistentry>
 
142
        <term><option>approved_by_default<literal> = </literal
 
143
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
144
          >true</literal> | <literal>on</literal> | <literal
 
145
          >0</literal> | <literal>no</literal> | <literal
 
146
          >false</literal> | <literal>off</literal> }</option></term>
 
147
        <listitem>
 
148
          <para>
 
149
            Whether to approve a client by default after
 
150
            the <option>approval_delay</option>.  The default
 
151
            is <quote>True</quote>.
150
152
          </para>
151
153
        </listitem>
152
154
      </varlistentry>
180
182
      </varlistentry>
181
183
      
182
184
      <varlistentry>
 
185
        <term><option>extended_timeout<literal> = </literal><replaceable
 
186
        >TIME</replaceable></option></term>
 
187
        <listitem>
 
188
          <para>
 
189
            This option is <emphasis>optional</emphasis>.
 
190
          </para>
 
191
          <para>
 
192
            Extended timeout is an added timeout that is given once
 
193
            after a password has been sent successfully to a client.
 
194
            The timeout is by default longer than the normal timeout,
 
195
            and is used for handling the extra long downtime while a
 
196
            machine is booting up.  Time to take into consideration
 
197
            when changing this value is file system checks and quota
 
198
            checks.  The default value is 15 minutes.
 
199
          </para>
 
200
          <para>
 
201
            The format of <replaceable>TIME</replaceable> is the same
 
202
            as for <varname>timeout</varname> below.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
      
 
207
      <varlistentry>
183
208
        <term><option>fingerprint<literal> = </literal
184
209
        ><replaceable>HEXSTRING</replaceable></option></term>
185
210
        <listitem>
196
221
      </varlistentry>
197
222
      
198
223
      <varlistentry>
 
224
        <term><option><literal>host = </literal><replaceable
 
225
        >STRING</replaceable></option></term>
 
226
        <listitem>
 
227
          <para>
 
228
            This option is <emphasis>optional</emphasis>, but highly
 
229
            <emphasis>recommended</emphasis> unless the
 
230
            <option>checker</option> option is modified to a
 
231
            non-standard value without <quote>%%(host)s</quote> in it.
 
232
          </para>
 
233
          <para>
 
234
            Host name for this client.  This is not used by the server
 
235
            directly, but can be, and is by default, used by the
 
236
            checker.  See the <option>checker</option> option.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>interval<literal> = </literal><replaceable
 
243
        >TIME</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            How often to run the checker to confirm that a client is
 
250
            still up.  <emphasis>Note:</emphasis> a new checker will
 
251
            not be started if an old one is still running.  The server
 
252
            will wait for a checker to complete until the below
 
253
            <quote><varname>timeout</varname></quote> occurs, at which
 
254
            time the client will be disabled, and any running checker
 
255
            killed.  The default interval is 2 minutes.
 
256
          </para>
 
257
          <para>
 
258
            The format of <replaceable>TIME</replaceable> is the same
 
259
            as for <varname>timeout</varname> below.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>secfile<literal> = </literal><replaceable
 
266
        >FILENAME</replaceable></option></term>
 
267
        <listitem>
 
268
          <para>
 
269
            This option is only used if <option>secret</option> is not
 
270
            specified, in which case this option is
 
271
            <emphasis>required</emphasis>.
 
272
          </para>
 
273
          <para>
 
274
            Similar to the <option>secret</option>, except the secret
 
275
            data is in an external file.  The contents of the file
 
276
            should <emphasis>not</emphasis> be base64-encoded, but
 
277
            will be sent to clients verbatim.
 
278
          </para>
 
279
          <para>
 
280
            File names of the form <filename>~user/foo/bar</filename>
 
281
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
282
            are supported.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
199
288
        <term><option>secret<literal> = </literal><replaceable
200
289
        >BASE64_ENCODED_DATA</replaceable></option></term>
201
290
        <listitem>
226
315
      </varlistentry>
227
316
      
228
317
      <varlistentry>
229
 
        <term><option>secfile<literal> = </literal><replaceable
230
 
        >FILENAME</replaceable></option></term>
 
318
        <term><option>timeout<literal> = </literal><replaceable
 
319
        >TIME</replaceable></option></term>
231
320
        <listitem>
232
321
          <para>
233
 
            This option is only used if <option>secret</option> is not
234
 
            specified, in which case this option is
235
 
            <emphasis>required</emphasis>.
236
 
          </para>
237
 
          <para>
238
 
            Similar to the <option>secret</option>, except the secret
239
 
            data is in an external file.  The contents of the file
240
 
            should <emphasis>not</emphasis> be base64-encoded, but
241
 
            will be sent to clients verbatim.
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.
 
322
            This option is <emphasis>optional</emphasis>.
 
323
          </para>
 
324
          <para>
 
325
            The timeout is how long the server will wait, after a
 
326
            successful checker run, until a client is disabled and not
 
327
            allowed to get the data this server holds.  By default
 
328
            Mandos will use 5 minutes.  See also the
 
329
            <option>extended_timeout</option> option.
 
330
          </para>
 
331
          <para>
 
332
            The <replaceable>TIME</replaceable> is specified as a
 
333
            space-separated number of values, each of which is a
 
334
            number and a one-character suffix.  The suffix must be one
 
335
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
336
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
337
            minutes, hours, and weeks, respectively.  The values are
 
338
            added together to give the total time value, so all of
 
339
            <quote><literal>330s</literal></quote>,
 
340
            <quote><literal>110s 110s 110s</literal></quote>, and
 
341
            <quote><literal>5m 30s</literal></quote> will give a value
 
342
            of five minutes and thirty seconds.
247
343
          </para>
248
344
        </listitem>
249
345
      </varlistentry>
250
346
      
251
347
      <varlistentry>
252
 
        <term><option><literal>host = </literal><replaceable
253
 
        >STRING</replaceable></option></term>
 
348
        <term><option>enabled<literal> = </literal>{ <literal
 
349
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
350
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
351
        >no</literal> | <literal>false</literal> | <literal
 
352
        >off</literal> }</option></term>
254
353
        <listitem>
255
354
          <para>
256
 
            This option is <emphasis>optional</emphasis>, but highly
257
 
            <emphasis>recommended</emphasis> unless the
258
 
            <option>checker</option> option is modified to a
259
 
            non-standard value without <quote>%%(host)s</quote> in it.
260
 
          </para>
261
 
          <para>
262
 
            Host name for this client.  This is not used by the server
263
 
            directly, but can be, and is by default, used by the
264
 
            checker.  See the <option>checker</option> option.
 
355
            Whether this client should be enabled by default.  The
 
356
            default is <quote>true</quote>.
265
357
          </para>
266
358
        </listitem>
267
359
      </varlistentry>
304
396
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
305
397
        ></quote> will be replaced by the value of the attribute
306
398
        <varname>foo</varname> of the internal
307
 
        <quote><classname>Client</classname></quote> object.  See the
308
 
        source code for details, and let the authors know of any
309
 
        attributes that are useful so they may be preserved to any new
310
 
        versions of this software.
 
399
        <quote><classname>Client</classname></quote> object in the
 
400
        Mandos server.  The currently allowed values for
 
401
        <replaceable>foo</replaceable> are:
 
402
        <quote><literal>approval_delay</literal></quote>,
 
403
        <quote><literal>approval_duration</literal></quote>,
 
404
        <quote><literal>created</literal></quote>,
 
405
        <quote><literal>enabled</literal></quote>,
 
406
        <quote><literal>fingerprint</literal></quote>,
 
407
        <quote><literal>host</literal></quote>,
 
408
        <quote><literal>interval</literal></quote>,
 
409
        <quote><literal>last_approval_request</literal></quote>,
 
410
        <quote><literal>last_checked_ok</literal></quote>,
 
411
        <quote><literal>last_enabled</literal></quote>,
 
412
        <quote><literal>name</literal></quote>,
 
413
        <quote><literal>timeout</literal></quote>, and, if using
 
414
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
415
        See the source code for details.  <emphasis role="strong"
 
416
        >Currently, <emphasis>none</emphasis> of these attributes
 
417
        except <quote><literal>host</literal></quote> are guaranteed
 
418
        to be valid in future versions.</emphasis> Therefore, please
 
419
        let the authors know of any attributes that are useful so they
 
420
        may be preserved to any new versions of this software.
311
421
      </para>
312
422
      <para>
313
423
        Note that this means that, in order to include an actual
348
458
    <informalexample>
349
459
      <programlisting>
350
460
[DEFAULT]
351
 
timeout = 1h
352
 
interval = 5m
 
461
timeout = 5m
 
462
interval = 2m
353
463
checker = fping -q -- %%(host)s
354
464
 
355
465
# Client "foo"
379
489
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
490
secfile = /etc/mandos/bar-secret
381
491
timeout = 15m
 
492
approved_by_default = False
 
493
approval_delay = 30s
382
494
      </programlisting>
383
495
    </informalexample>
384
496
  </refsect1>
386
498
  <refsect1 id="see_also">
387
499
    <title>SEE ALSO</title>
388
500
    <para>
 
501
      <citerefentry><refentrytitle>intro</refentrytitle>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>,
389
503
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
390
504
      <manvolnum>8</manvolnum></citerefentry>,
391
505
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>