/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: 2024-09-09 04:24:39 UTC
  • Revision ID: teddy@recompile.se-20240909042439-j85mr20uli2hnyis
Eliminate compiler warnings

Many programs use nested functions, which now result in a linker
warning about executable stack.  Hide this warning.  Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).

* Makefile (plugin-runner, dracut-module/password-agent,
  plugins.d/password-prompt, plugins.d/mandos-client,
  plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
  --no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
  are looking through the process list, go though it from the start
  instead of from the end, i.e. in normal alphabetical order and not
  in reverse order.

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