/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 at bsnet
  • Date: 2010-09-14 18:22:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100914182203-w26c64tdthto4jg2
* mandos-monitor.xml: New.
* Makefile (PROGS): Add "mandos-monitor".
  (DOCS): Add "mandos-monitor.xml".
  (mandos-monitor.8, mandos-monitor.8.xhtml, mandos-monitor): New.
  (install-server): Install "mandos-ctl" and "mandos-monitor" too.
  (uninstall-server): Remove "mandos-ctl" and "mandos-monitor" too.
* mandos-monitor: Don't log uninteresting messages.

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