/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2017-02-23 19:11:11 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 358.
  • Revision ID: teddy@recompile.se-20170223191111-poodzw0cr26utaz0
Update copyright year to 2017

* DBUS-API: Update copyright year to 2017.
* debian/copyright: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

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