/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-08-22 00:16:20 UTC
  • mfrom: (24.1.57 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080822001620-vxpn1evy0t0kyvj0
* clients.conf ([DEFAULT]/checker): Update to new default value.

* mandos (Client.start_checker): Bug fix: OSError, not
                                 subprocess.OSError.
  (main): Use "fping -q -- %(host)s" instead of "fping -q --
          %%(host)s" as default value for "checker".  Always redirect
          stdin to be from /dev/null, even if in debug mode.

* mandos-clients.conf.xml (DESCRIPTION): Improved wording and refer to
                                         the EXPANSION section.
  (OPTIONS): Added synopsis and improved wording for "checker",
             "fingerprint", and "secret".  Refer to the RUNTIME
             EXPANSION section for the "checker" option.
  (EXAMPLE): Update to new default value for "checker".

* mandos-keygen (trap): Split lines and add "set +e".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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 "2016-06-23">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
21
18
        <surname>Påhlsson</surname>
22
19
        <address>
23
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
24
21
        </address>
25
22
      </author>
26
23
      <author>
27
24
        <firstname>Teddy</firstname>
28
25
        <surname>Hogeborn</surname>
29
26
        <address>
30
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
31
28
        </address>
32
29
      </author>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
 
      <year>2016</year>
44
33
      <holder>Teddy Hogeborn</holder>
45
34
      <holder>Björn Påhlsson</holder>
46
35
    </copyright>
47
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
48
59
  </refentryinfo>
49
 
  
 
60
 
50
61
  <refmeta>
51
62
    <refentrytitle>&CONFNAME;</refentrytitle>
52
63
    <manvolnum>5</manvolnum>
58
69
      Configuration file for the Mandos server
59
70
    </refpurpose>
60
71
  </refnamediv>
61
 
  
 
72
 
62
73
  <refsynopsisdiv>
63
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
64
77
  </refsynopsisdiv>
65
 
  
 
78
 
66
79
  <refsect1 id="description">
67
80
    <title>DESCRIPTION</title>
68
81
    <para>
69
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
70
83
      ><refentrytitle>mandos</refentrytitle>
71
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
 
      The file needs to list all clients that should be able to use
73
 
      the service.  The settings in this file can be overridden by
74
 
      runtime changes to the server, which it saves across restarts.
75
 
      (See the section called <quote>PERSISTENT STATE</quote> in
76
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
78
 
      >changes</emphasis> to this file (including adding and removing
79
 
      clients) will, at startup, override changes done during runtime.
 
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
 
85
      where each client that will be able to use the service needs to
 
86
      be listed.  All clients listed will be regarded as valid, even
 
87
      if a client was declared invalid in a previous run of the
 
88
      server.
80
89
    </para>
81
90
    <para>
82
91
      The format starts with a <literal>[<replaceable>section
102
111
  <refsect1 id="options">
103
112
    <title>OPTIONS</title>
104
113
    <para>
105
 
      <emphasis>Note:</emphasis> all option values are subject to
106
 
      start time expansion, see <xref linkend="expansion"/>.
107
 
    </para>
108
 
    <para>
109
 
      Unknown options are ignored.  The used options are as follows:
110
 
    </para>
111
 
    
 
114
      The possible options are:
 
115
    </para>
 
116
 
112
117
    <variablelist>
113
 
      
114
 
      <varlistentry>
115
 
        <term><option>approval_delay<literal> = </literal><replaceable
116
 
        >TIME</replaceable></option></term>
117
 
        <listitem>
118
 
          <para>
119
 
            This option is <emphasis>optional</emphasis>.
120
 
          </para>
121
 
          <para>
122
 
            How long to wait for external approval before resorting to
123
 
            use the <option>approved_by_default</option> value.  The
124
 
            default is <quote>PT0S</quote>, i.e. not to wait.
125
 
          </para>
126
 
          <para>
127
 
            The format of <replaceable>TIME</replaceable> is the same
128
 
            as for <varname>timeout</varname> below.
129
 
          </para>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
      
133
 
      <varlistentry>
134
 
        <term><option>approval_duration<literal> = </literal
135
 
        ><replaceable>TIME</replaceable></option></term>
136
 
        <listitem>
137
 
          <para>
138
 
            This option is <emphasis>optional</emphasis>.
139
 
          </para>
140
 
          <para>
141
 
            How long an external approval lasts.  The default is 1
142
 
            second.
143
 
          </para>
144
 
          <para>
145
 
            The format of <replaceable>TIME</replaceable> is the same
146
 
            as for <varname>timeout</varname> below.
147
 
          </para>
148
 
        </listitem>
149
 
      </varlistentry>
150
 
      
151
 
      <varlistentry>
152
 
        <term><option>approved_by_default<literal> = </literal
153
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
154
 
          >true</literal> | <literal>on</literal> | <literal
155
 
          >0</literal> | <literal>no</literal> | <literal
156
 
          >false</literal> | <literal>off</literal> }</option></term>
157
 
        <listitem>
158
 
          <para>
159
 
            Whether to approve a client by default after
160
 
            the <option>approval_delay</option>.  The default
161
 
            is <quote>True</quote>.
162
 
          </para>
163
 
        </listitem>
164
 
      </varlistentry>
165
 
      
166
 
      <varlistentry>
167
 
        <term><option>checker<literal> = </literal><replaceable
168
 
        >COMMAND</replaceable></option></term>
169
 
        <listitem>
170
 
          <para>
171
 
            This option is <emphasis>optional</emphasis>.
172
 
          </para>
173
 
          <para>
174
 
            This option overrides the default shell command that the
175
 
            server will use to check if the client is still up.  Any
176
 
            output of the command will be ignored, only the exit code
177
 
            is checked:  If the exit code of the command is zero, the
178
 
            client is considered up.  The command will be run using
 
118
 
 
119
      <varlistentry>
 
120
        <term><literal><varname>timeout</varname></literal></term>
 
121
        <listitem>
 
122
          <synopsis><literal>timeout = </literal><replaceable
 
123
          >TIME</replaceable>
 
124
          </synopsis>
 
125
          <para>
 
126
            The timeout is how long the server will wait for a
 
127
            successful checker run until a client is considered
 
128
            invalid - that is, ineligible to get the data this server
 
129
            holds.  By default Mandos will use 1 hour.
 
130
          </para>
 
131
          <para>
 
132
            The <replaceable>TIME</replaceable> is specified as a
 
133
            space-separated number of values, each of which is a
 
134
            number and a one-character suffix.  The suffix must be one
 
135
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
136
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
137
            minutes, hours, and weeks, respectively.  The values are
 
138
            added together to give the total time value, so all of
 
139
            <quote><literal>330s</literal></quote>,
 
140
            <quote><literal>110s 110s 110s</literal></quote>, and
 
141
            <quote><literal>5m 30s</literal></quote> will give a value
 
142
            of five minutes and thirty seconds.
 
143
          </para>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
 
 
147
      <varlistentry>
 
148
        <term><literal><varname>interval</varname></literal></term>
 
149
        <listitem>
 
150
          <synopsis><literal>interval = </literal><replaceable
 
151
          >TIME</replaceable>
 
152
          </synopsis>
 
153
          <para>
 
154
            How often to run the checker to confirm that a client is
 
155
            still up.  <emphasis>Note:</emphasis> a new checker will
 
156
            not be started if an old one is still running.  The server
 
157
            will wait for a checker to complete until the above
 
158
            <quote><varname>timeout</varname></quote> occurs, at which
 
159
            time the client will be marked invalid, and any running
 
160
            checker killed.  The default interval is 5 minutes.
 
161
          </para>
 
162
          <para>
 
163
            The format of <replaceable>TIME</replaceable> is the same
 
164
            as for <varname>timeout</varname> above.
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>      
 
168
 
 
169
      <varlistentry>
 
170
        <term><literal>checker</literal></term>
 
171
        <listitem>
 
172
          <synopsis><literal>checker = </literal><replaceable
 
173
          >COMMAND</replaceable>
 
174
          </synopsis>
 
175
          <para>
 
176
            This option allows you to override the default shell
 
177
            command that the server will use to check if the client is
 
178
            still up.  The output of the command will be ignored, only
 
179
            the exit code is checked.  The command will be run using
179
180
            <quote><command><filename>/bin/sh</filename>
180
 
            <option>-c</option></command></quote>, so
181
 
            <varname>PATH</varname> will be searched.  The default
182
 
            value for the checker command is <quote><literal
183
 
            ><command>fping</command> <option>-q</option> <option
184
 
            >--</option> %%(host)s</literal></quote>.  Note that
185
 
            <command>mandos-keygen</command>, when generating output
186
 
            to be inserted into this file, normally looks for an SSH
187
 
            server on the Mandos client, and, if it find one, outputs
188
 
            a <option>checker</option> option to check for the
189
 
            client’s key fingerprint – this is more secure against
190
 
            spoofing.
 
181
            <option>-c</option></command></quote>.  The default
 
182
            command is <quote><literal><command>fping</command>
 
183
            <option>-q</option> <option>--</option>
 
184
            %(host)s</literal></quote>.
191
185
          </para>
192
186
          <para>
193
187
            In addition to normal start time expansion, this option
198
192
      </varlistentry>
199
193
      
200
194
      <varlistentry>
201
 
        <term><option>extended_timeout<literal> = </literal><replaceable
202
 
        >TIME</replaceable></option></term>
203
 
        <listitem>
204
 
          <para>
205
 
            This option is <emphasis>optional</emphasis>.
206
 
          </para>
207
 
          <para>
208
 
            Extended timeout is an added timeout that is given once
209
 
            after a password has been sent successfully to a client.
210
 
            The timeout is by default longer than the normal timeout,
211
 
            and is used for handling the extra long downtime while a
212
 
            machine is booting up.  Time to take into consideration
213
 
            when changing this value is file system checks and quota
214
 
            checks.  The default value is 15 minutes.
215
 
          </para>
216
 
          <para>
217
 
            The format of <replaceable>TIME</replaceable> is the same
218
 
            as for <varname>timeout</varname> below.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
 
        <term><option>fingerprint<literal> = </literal
225
 
        ><replaceable>HEXSTRING</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            This option is <emphasis>required</emphasis>.
229
 
          </para>
 
195
        <term><literal>fingerprint</literal></term>
 
196
        <listitem>
 
197
          <synopsis><literal>fingerprint = </literal><replaceable
 
198
          >HEXSTRING</replaceable>
 
199
          </synopsis>
230
200
          <para>
231
201
            This option sets the OpenPGP fingerprint that identifies
232
202
            the public key that clients authenticate themselves with
233
 
            through TLS.  The string needs to be in hexadecimal form,
 
203
            through TLS.  The string needs to be in hexidecimal form,
234
204
            but spaces or upper/lower case are not significant.
235
205
          </para>
236
206
        </listitem>
237
207
      </varlistentry>
238
208
      
239
209
      <varlistentry>
240
 
        <term><option><literal>host = </literal><replaceable
241
 
        >STRING</replaceable></option></term>
242
 
        <listitem>
243
 
          <para>
244
 
            This option is <emphasis>optional</emphasis>, but highly
245
 
            <emphasis>recommended</emphasis> unless the
246
 
            <option>checker</option> option is modified to a
247
 
            non-standard value without <quote>%%(host)s</quote> in it.
248
 
          </para>
249
 
          <para>
250
 
            Host name for this client.  This is not used by the server
251
 
            directly, but can be, and is by default, used by the
252
 
            checker.  See the <option>checker</option> option.
253
 
          </para>
254
 
        </listitem>
255
 
      </varlistentry>
256
 
      
257
 
      <varlistentry>
258
 
        <term><option>interval<literal> = </literal><replaceable
259
 
        >TIME</replaceable></option></term>
260
 
        <listitem>
261
 
          <para>
262
 
            This option is <emphasis>optional</emphasis>.
263
 
          </para>
264
 
          <para>
265
 
            How often to run the checker to confirm that a client is
266
 
            still up.  <emphasis>Note:</emphasis> a new checker will
267
 
            not be started if an old one is still running.  The server
268
 
            will wait for a checker to complete until the below
269
 
            <quote><varname>timeout</varname></quote> occurs, at which
270
 
            time the client will be disabled, and any running checker
271
 
            killed.  The default interval is 2 minutes.
272
 
          </para>
273
 
          <para>
274
 
            The format of <replaceable>TIME</replaceable> is the same
275
 
            as for <varname>timeout</varname> below.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
      
280
 
      <varlistentry>
281
 
        <term><option>secfile<literal> = </literal><replaceable
282
 
        >FILENAME</replaceable></option></term>
283
 
        <listitem>
284
 
          <para>
285
 
            This option is only used if <option>secret</option> is not
286
 
            specified, in which case this option is
287
 
            <emphasis>required</emphasis>.
288
 
          </para>
289
 
          <para>
290
 
            Similar to the <option>secret</option>, except the secret
291
 
            data is in an external file.  The contents of the file
292
 
            should <emphasis>not</emphasis> be base64-encoded, but
293
 
            will be sent to clients verbatim.
294
 
          </para>
295
 
          <para>
296
 
            File names of the form <filename>~user/foo/bar</filename>
297
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
298
 
            are supported.
299
 
          </para>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
      
303
 
      <varlistentry>
304
 
        <term><option>secret<literal> = </literal><replaceable
305
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
306
 
        <listitem>
307
 
          <para>
308
 
            If this option is not specified, the <option
309
 
            >secfile</option> option is <emphasis>required</emphasis>
310
 
            to be present.
311
 
          </para>
 
210
        <term><literal>secret</literal></term>
 
211
        <listitem>
 
212
          <synopsis><literal>secret = </literal><replaceable
 
213
          >BASE64_ENCODED_DATA</replaceable>
 
214
          </synopsis>
312
215
          <para>
313
216
            If present, this option must be set to a string of
314
217
            base64-encoded binary data.  It will be decoded and sent
315
218
            to the client matching the above
316
219
            <option>fingerprint</option>.  This should, of course, be
317
220
            OpenPGP encrypted data, decryptable only by the client.
318
 
            The program <citerefentry><refentrytitle><command
319
 
            >mandos-keygen</command></refentrytitle><manvolnum
320
 
            >8</manvolnum></citerefentry> can, using its
321
 
            <option>--password</option> option, be used to generate
322
 
            this, if desired.
323
 
          </para>
324
 
          <para>
325
 
            Note: this value of this option will probably be very
326
 
            long.  A useful feature to avoid having unreadably-long
327
 
            lines is that a line beginning with white space adds to
328
 
            the value of the previous line, RFC 822-style.
329
 
          </para>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
 
        <term><option>timeout<literal> = </literal><replaceable
335
 
        >TIME</replaceable></option></term>
336
 
        <listitem>
337
 
          <para>
338
 
            This option is <emphasis>optional</emphasis>.
339
 
          </para>
340
 
          <para>
341
 
            The timeout is how long the server will wait, after a
342
 
            successful checker run, until a client is disabled and not
343
 
            allowed to get the data this server holds.  By default
344
 
            Mandos will use 5 minutes.  See also the
345
 
            <option>extended_timeout</option> option.
346
 
          </para>
347
 
          <para>
348
 
            The <replaceable>TIME</replaceable> is specified as an RFC
349
 
            3339 duration; for example
350
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
 
            one year, two months, three days, four hours, five
352
 
            minutes, and six seconds.  Some values can be omitted, see
353
 
            RFC 3339 Appendix A for details.
354
 
          </para>
355
 
        </listitem>
356
 
      </varlistentry>
357
 
      
358
 
      <varlistentry>
359
 
        <term><option>enabled<literal> = </literal>{ <literal
360
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
361
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
362
 
        >no</literal> | <literal>false</literal> | <literal
363
 
        >off</literal> }</option></term>
364
 
        <listitem>
365
 
          <para>
366
 
            Whether this client should be enabled by default.  The
367
 
            default is <quote>true</quote>.
368
 
          </para>
369
 
        </listitem>
370
 
      </varlistentry>
 
221
<!--        The program <citerefentry><refentrytitle><command -->
 
222
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
 
223
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
 
224
<!--        if desired. -->
 
225
          </para>
 
226
          <para>
 
227
            Note: this value of this option will probably run over
 
228
            many lines, and will then have to use the fact that a line
 
229
            beginning with white space adds to the value of the
 
230
            previous line, RFC 822-style.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>secfile</literal></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Base 64 encoded OpenPGP encrypted password encrypted by
 
240
            the clients openpgp certificate as a binary file.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
 
 
245
      <varlistentry>
 
246
        <term><literal>host</literal></term>
 
247
        <listitem>
 
248
          <para>
 
249
            Host name that can be used in for checking that the client is up.
 
250
          </para>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
 
 
254
      <varlistentry>
 
255
        <term><literal>checker</literal></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Shell command that the server will use to check up if a
 
259
            client is still up.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>      
 
263
 
 
264
      <varlistentry>
 
265
        <term><literal>timeout</literal></term>
 
266
        <listitem>
 
267
          <para>
 
268
            Duration that a client can be down whitout be removed from
 
269
            the client list.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry> 
371
273
      
372
274
    </variablelist>
373
 
  </refsect1>
 
275
  </refsect1>  
374
276
  
375
277
  <refsect1 id="expansion">
376
278
    <title>EXPANSION</title>
407
309
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
408
310
        ></quote> will be replaced by the value of the attribute
409
311
        <varname>foo</varname> of the internal
410
 
        <quote><classname>Client</classname></quote> object in the
411
 
        Mandos server.  The currently allowed values for
412
 
        <replaceable>foo</replaceable> are:
413
 
        <quote><literal>approval_delay</literal></quote>,
414
 
        <quote><literal>approval_duration</literal></quote>,
415
 
        <quote><literal>created</literal></quote>,
416
 
        <quote><literal>enabled</literal></quote>,
417
 
        <quote><literal>expires</literal></quote>,
418
 
        <quote><literal>fingerprint</literal></quote>,
419
 
        <quote><literal>host</literal></quote>,
420
 
        <quote><literal>interval</literal></quote>,
421
 
        <quote><literal>last_approval_request</literal></quote>,
422
 
        <quote><literal>last_checked_ok</literal></quote>,
423
 
        <quote><literal>last_enabled</literal></quote>,
424
 
        <quote><literal>name</literal></quote>,
425
 
        <quote><literal>timeout</literal></quote>, and, if using
426
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
427
 
        See the source code for details.  <emphasis role="strong"
428
 
        >Currently, <emphasis>none</emphasis> of these attributes
429
 
        except <quote><literal>host</literal></quote> are guaranteed
430
 
        to be valid in future versions.</emphasis> Therefore, please
431
 
        let the authors know of any attributes that are useful so they
432
 
        may be preserved to any new versions of this software.
 
312
        <quote><classname>Client</classname></quote> object.  See the
 
313
        source code for details, and let the authors know of any
 
314
        attributes that are useful so they may be preserved to any new
 
315
        versions of this software.
433
316
      </para>
434
317
      <para>
435
318
        Note that this means that, in order to include an actual
436
319
        percent character (<quote>%</quote>) in a
437
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
320
        <varname>checker</varname> options, <emphasis>four</emphasis>
438
321
        percent characters in a row (<quote>%%%%</quote>) must be
439
322
        entered.  Also, a bad format here will lead to an immediate
440
323
        but <emphasis>silent</emphasis> run-time fatal exit; debug
441
 
        mode is needed to expose an error of this kind.
 
324
        mode is needed to track down an error of this kind.
442
325
      </para>
443
326
    </refsect2>
444
 
    
445
 
  </refsect1>
 
327
 
 
328
  </refsect1>  
446
329
  
447
330
  <refsect1 id="files">
448
331
    <title>FILES</title>
463
346
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
464
347
      obscure.
465
348
    </para>
466
 
    <xi:include href="bugs.xml"/>
467
349
  </refsect1>
468
350
  
469
351
  <refsect1 id="example">
471
353
    <informalexample>
472
354
      <programlisting>
473
355
[DEFAULT]
474
 
timeout = PT5M
475
 
interval = PT2M
476
 
checker = fping -q -- %%(host)s
 
356
timeout = 1h
 
357
interval = 5m
 
358
checker = fping -q -- %(host)s
477
359
 
478
360
# Client "foo"
479
361
[foo]
494
376
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
495
377
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
496
378
        QlnHIvPzEArRQLo=
 
379
        =iHhv
497
380
host = foo.example.org
498
 
interval = PT1M
 
381
interval = 5m
499
382
 
500
383
# Client "bar"
501
384
[bar]
502
385
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
503
 
secfile = /etc/mandos/bar-secret
504
 
timeout = PT15M
505
 
approved_by_default = False
506
 
approval_delay = PT30S
 
386
secfile = /etc/mandos/bar-secret.txt.asc
 
387
 
507
388
      </programlisting>
508
389
    </informalexample>
509
 
  </refsect1>
510
 
  
511
 
  <refsect1 id="see_also">
512
 
    <title>SEE ALSO</title>
513
 
    <para>
514
 
      <citerefentry><refentrytitle>intro</refentrytitle>
515
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
516
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
517
 
      <manvolnum>8</manvolnum></citerefentry>,
518
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
519
 
      <manvolnum>5</manvolnum></citerefentry>,
520
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
521
 
      <manvolnum>8</manvolnum></citerefentry>,
522
 
      <citerefentry><refentrytitle>fping</refentrytitle>
523
 
      <manvolnum>8</manvolnum></citerefentry>
524
 
    </para>
525
 
    <variablelist>
526
 
      <varlistentry>
527
 
        <term>
528
 
          RFC 3339: <citetitle>Date and Time on the Internet:
529
 
          Timestamps</citetitle>
530
 
        </term>
531
 
      <listitem>
532
 
        <para>
533
 
          The time intervals are in the "duration" format, as
534
 
          specified in ABNF in Appendix A of RFC 3339.
535
 
        </para>
536
 
      </listitem>
537
 
      </varlistentry>
538
 
    </variablelist>
539
 
  </refsect1>
 
390
  </refsect1>  
 
391
 
540
392
</refentry>
541
 
<!-- Local Variables: -->
542
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
543
 
<!-- time-stamp-end: "[\"']>" -->
544
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
545
 
<!-- End: -->