/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: 2012-05-12 19:56:55 UTC
  • mfrom: (237.6.2 nmu)
  • mto: (237.4.31 release)
  • mto: This revision was merged to the branch mainline in revision 586.
  • Revision ID: teddy@recompile.se-20120512195655-cy7w8ts3l9p22l3z
Tags: version-1.5.3-1.2
Merge NMU change

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-01-08">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
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>
 
39
      <year>2012</year>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
63
66
      ><refentrytitle>mandos</refentrytitle>
64
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
68
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as valid, even
67
 
      if a client was declared invalid in a previous run of the
68
 
      server.
 
69
      the service.  The settings in this file can be overridden by
 
70
      runtime changes to the server, which it saves across restarts.
 
71
      (See the section called <quote>PERSISTENT STATE</quote> in
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
73
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
74
      >changes</emphasis> to this file (including adding and removing
 
75
      clients) will, at startup, override changes done during runtime.
69
76
    </para>
70
77
    <para>
71
78
      The format starts with a <literal>[<replaceable>section
101
108
    <variablelist>
102
109
      
103
110
      <varlistentry>
104
 
        <term><option>timeout<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
106
 
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
110
 
          <para>
111
 
            The timeout is how long the server will wait for a
112
 
            successful checker run until a client is considered
113
 
            invalid - that is, ineligible to get the data this server
114
 
            holds.  By default Mandos will use 1 hour.
115
 
          </para>
116
 
          <para>
117
 
            The <replaceable>TIME</replaceable> is specified as a
118
 
            space-separated number of values, each of which is a
119
 
            number and a one-character suffix.  The suffix must be one
120
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
122
 
            minutes, hours, and weeks, respectively.  The values are
123
 
            added together to give the total time value, so all of
124
 
            <quote><literal>330s</literal></quote>,
125
 
            <quote><literal>110s 110s 110s</literal></quote>, and
126
 
            <quote><literal>5m 30s</literal></quote> will give a value
127
 
            of five minutes and thirty seconds.
128
 
          </para>
129
 
        </listitem>
130
 
      </varlistentry>
131
 
      
132
 
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
135
 
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
139
 
          <para>
140
 
            How often to run the checker to confirm that a client is
141
 
            still up.  <emphasis>Note:</emphasis> a new checker will
142
 
            not be started if an old one is still running.  The server
143
 
            will wait for a checker to complete until the above
144
 
            <quote><varname>timeout</varname></quote> occurs, at which
145
 
            time the client will be marked invalid, and any running
146
 
            checker killed.  The default interval is 5 minutes.
147
 
          </para>
148
 
          <para>
149
 
            The format of <replaceable>TIME</replaceable> is the same
150
 
            as for <varname>timeout</varname> above.
 
111
        <term><option>approval_delay<literal> = </literal><replaceable
 
112
        >TIME</replaceable></option></term>
 
113
        <listitem>
 
114
          <para>
 
115
            This option is <emphasis>optional</emphasis>.
 
116
          </para>
 
117
          <para>
 
118
            How long to wait for external approval before resorting to
 
119
            use the <option>approved_by_default</option> value.  The
 
120
            default is <quote>0s</quote>, i.e. not to wait.
 
121
          </para>
 
122
          <para>
 
123
            The format of <replaceable>TIME</replaceable> is the same
 
124
            as for <varname>timeout</varname> below.
 
125
          </para>
 
126
        </listitem>
 
127
      </varlistentry>
 
128
      
 
129
      <varlistentry>
 
130
        <term><option>approval_duration<literal> = </literal
 
131
        ><replaceable>TIME</replaceable></option></term>
 
132
        <listitem>
 
133
          <para>
 
134
            This option is <emphasis>optional</emphasis>.
 
135
          </para>
 
136
          <para>
 
137
            How long an external approval lasts.  The default is 1
 
138
            second.
 
139
          </para>
 
140
          <para>
 
141
            The format of <replaceable>TIME</replaceable> is the same
 
142
            as for <varname>timeout</varname> below.
 
143
          </para>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>approved_by_default<literal> = </literal
 
149
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
150
          >true</literal> | <literal>on</literal> | <literal
 
151
          >0</literal> | <literal>no</literal> | <literal
 
152
          >false</literal> | <literal>off</literal> }</option></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Whether to approve a client by default after
 
156
            the <option>approval_delay</option>.  The default
 
157
            is <quote>True</quote>.
151
158
          </para>
152
159
        </listitem>
153
160
      </varlistentry>
181
188
      </varlistentry>
182
189
      
183
190
      <varlistentry>
 
191
        <term><option>extended_timeout<literal> = </literal><replaceable
 
192
        >TIME</replaceable></option></term>
 
193
        <listitem>
 
194
          <para>
 
195
            This option is <emphasis>optional</emphasis>.
 
196
          </para>
 
197
          <para>
 
198
            Extended timeout is an added timeout that is given once
 
199
            after a password has been sent successfully to a client.
 
200
            The timeout is by default longer than the normal timeout,
 
201
            and is used for handling the extra long downtime while a
 
202
            machine is booting up.  Time to take into consideration
 
203
            when changing this value is file system checks and quota
 
204
            checks.  The default value is 15 minutes.
 
205
          </para>
 
206
          <para>
 
207
            The format of <replaceable>TIME</replaceable> is the same
 
208
            as for <varname>timeout</varname> below.
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
184
214
        <term><option>fingerprint<literal> = </literal
185
215
        ><replaceable>HEXSTRING</replaceable></option></term>
186
216
        <listitem>
197
227
      </varlistentry>
198
228
      
199
229
      <varlistentry>
 
230
        <term><option><literal>host = </literal><replaceable
 
231
        >STRING</replaceable></option></term>
 
232
        <listitem>
 
233
          <para>
 
234
            This option is <emphasis>optional</emphasis>, but highly
 
235
            <emphasis>recommended</emphasis> unless the
 
236
            <option>checker</option> option is modified to a
 
237
            non-standard value without <quote>%%(host)s</quote> in it.
 
238
          </para>
 
239
          <para>
 
240
            Host name for this client.  This is not used by the server
 
241
            directly, but can be, and is by default, used by the
 
242
            checker.  See the <option>checker</option> option.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>interval<literal> = </literal><replaceable
 
249
        >TIME</replaceable></option></term>
 
250
        <listitem>
 
251
          <para>
 
252
            This option is <emphasis>optional</emphasis>.
 
253
          </para>
 
254
          <para>
 
255
            How often to run the checker to confirm that a client is
 
256
            still up.  <emphasis>Note:</emphasis> a new checker will
 
257
            not be started if an old one is still running.  The server
 
258
            will wait for a checker to complete until the below
 
259
            <quote><varname>timeout</varname></quote> occurs, at which
 
260
            time the client will be disabled, and any running checker
 
261
            killed.  The default interval is 2 minutes.
 
262
          </para>
 
263
          <para>
 
264
            The format of <replaceable>TIME</replaceable> is the same
 
265
            as for <varname>timeout</varname> below.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>secfile<literal> = </literal><replaceable
 
272
        >FILENAME</replaceable></option></term>
 
273
        <listitem>
 
274
          <para>
 
275
            This option is only used if <option>secret</option> is not
 
276
            specified, in which case this option is
 
277
            <emphasis>required</emphasis>.
 
278
          </para>
 
279
          <para>
 
280
            Similar to the <option>secret</option>, except the secret
 
281
            data is in an external file.  The contents of the file
 
282
            should <emphasis>not</emphasis> be base64-encoded, but
 
283
            will be sent to clients verbatim.
 
284
          </para>
 
285
          <para>
 
286
            File names of the form <filename>~user/foo/bar</filename>
 
287
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
288
            are supported.
 
289
          </para>
 
290
        </listitem>
 
291
      </varlistentry>
 
292
      
 
293
      <varlistentry>
200
294
        <term><option>secret<literal> = </literal><replaceable
201
295
        >BASE64_ENCODED_DATA</replaceable></option></term>
202
296
        <listitem>
227
321
      </varlistentry>
228
322
      
229
323
      <varlistentry>
230
 
        <term><option>secfile<literal> = </literal><replaceable
231
 
        >FILENAME</replaceable></option></term>
 
324
        <term><option>timeout<literal> = </literal><replaceable
 
325
        >TIME</replaceable></option></term>
232
326
        <listitem>
233
327
          <para>
234
 
            This option is only used if <option>secret</option> is not
235
 
            specified, in which case this option is
236
 
            <emphasis>required</emphasis>.
237
 
          </para>
238
 
          <para>
239
 
            Similar to the <option>secret</option>, except the secret
240
 
            data is in an external file.  The contents of the file
241
 
            should <emphasis>not</emphasis> be base64-encoded, but
242
 
            will be sent to clients verbatim.
243
 
          </para>
244
 
          <para>
245
 
            File names of the form <filename>~user/foo/bar</filename>
246
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
 
            are supported.
 
328
            This option is <emphasis>optional</emphasis>.
 
329
          </para>
 
330
          <para>
 
331
            The timeout is how long the server will wait, after a
 
332
            successful checker run, until a client is disabled and not
 
333
            allowed to get the data this server holds.  By default
 
334
            Mandos will use 5 minutes.  See also the
 
335
            <option>extended_timeout</option> option.
 
336
          </para>
 
337
          <para>
 
338
            The <replaceable>TIME</replaceable> is specified as a
 
339
            space-separated number of values, each of which is a
 
340
            number and a one-character suffix.  The suffix must be one
 
341
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
342
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
343
            minutes, hours, and weeks, respectively.  The values are
 
344
            added together to give the total time value, so all of
 
345
            <quote><literal>330s</literal></quote>,
 
346
            <quote><literal>110s 110s 110s</literal></quote>, and
 
347
            <quote><literal>5m 30s</literal></quote> will give a value
 
348
            of five minutes and thirty seconds.
248
349
          </para>
249
350
        </listitem>
250
351
      </varlistentry>
251
352
      
252
353
      <varlistentry>
253
 
        <term><option><literal>host = </literal><replaceable
254
 
        >STRING</replaceable></option></term>
 
354
        <term><option>enabled<literal> = </literal>{ <literal
 
355
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
356
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
357
        >no</literal> | <literal>false</literal> | <literal
 
358
        >off</literal> }</option></term>
255
359
        <listitem>
256
360
          <para>
257
 
            This option is <emphasis>optional</emphasis>, but highly
258
 
            <emphasis>recommended</emphasis> unless the
259
 
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%(host)s</quote> in it.
261
 
          </para>
262
 
          <para>
263
 
            Host name for this client.  This is not used by the server
264
 
            directly, but can be, and is by default, used by the
265
 
            checker.  See the <option>checker</option> option.
 
361
            Whether this client should be enabled by default.  The
 
362
            default is <quote>true</quote>.
266
363
          </para>
267
364
        </listitem>
268
365
      </varlistentry>
305
402
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
306
403
        ></quote> will be replaced by the value of the attribute
307
404
        <varname>foo</varname> of the internal
308
 
        <quote><classname>Client</classname></quote> object.  See the
309
 
        source code for details, and let the authors know of any
310
 
        attributes that are useful so they may be preserved to any new
311
 
        versions of this software.
 
405
        <quote><classname>Client</classname></quote> object in the
 
406
        Mandos server.  The currently allowed values for
 
407
        <replaceable>foo</replaceable> are:
 
408
        <quote><literal>approval_delay</literal></quote>,
 
409
        <quote><literal>approval_duration</literal></quote>,
 
410
        <quote><literal>created</literal></quote>,
 
411
        <quote><literal>enabled</literal></quote>,
 
412
        <quote><literal>fingerprint</literal></quote>,
 
413
        <quote><literal>host</literal></quote>,
 
414
        <quote><literal>interval</literal></quote>,
 
415
        <quote><literal>last_approval_request</literal></quote>,
 
416
        <quote><literal>last_checked_ok</literal></quote>,
 
417
        <quote><literal>last_enabled</literal></quote>,
 
418
        <quote><literal>name</literal></quote>,
 
419
        <quote><literal>timeout</literal></quote>, and, if using
 
420
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
421
        See the source code for details.  <emphasis role="strong"
 
422
        >Currently, <emphasis>none</emphasis> of these attributes
 
423
        except <quote><literal>host</literal></quote> are guaranteed
 
424
        to be valid in future versions.</emphasis> Therefore, please
 
425
        let the authors know of any attributes that are useful so they
 
426
        may be preserved to any new versions of this software.
312
427
      </para>
313
428
      <para>
314
429
        Note that this means that, in order to include an actual
349
464
    <informalexample>
350
465
      <programlisting>
351
466
[DEFAULT]
352
 
timeout = 1h
353
 
interval = 5m
 
467
timeout = 5m
 
468
interval = 2m
354
469
checker = fping -q -- %%(host)s
355
470
 
356
471
# Client "foo"
380
495
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
496
secfile = /etc/mandos/bar-secret
382
497
timeout = 15m
 
498
approved_by_default = False
 
499
approval_delay = 30s
383
500
      </programlisting>
384
501
    </informalexample>
385
502
  </refsect1>
387
504
  <refsect1 id="see_also">
388
505
    <title>SEE ALSO</title>
389
506
    <para>
 
507
      <citerefentry><refentrytitle>intro</refentrytitle>
 
508
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
509
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
510
      <manvolnum>8</manvolnum></citerefentry>,
392
511
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>