/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: 2018-08-19 01:35:11 UTC
  • Revision ID: teddy@recompile.se-20180819013511-cku25q9yeub3dnr0
Adapt to changes in cryptsetup; use "cryptroot-unlock" program

* Makefile (install-client-nokey): Also install new script files
  "mandos-to-cryptroot-unlock" and "initramfs-tools-script-stop".
* debian/mandos-client.dirs: Add
  "usr/share/initramfs-tools/scripts/local-premount".
* initramfs-tools-hook: Also copy "mandos-to-cryptroot-unlock".
* initramfs-tools-script: Only modify keyscript setting in cryptroot
  file if the file exists, otherwise start
  "mandos-to-cryptroot-unlock" in background.
* initramfs-tools-script-stop: New script to make sure plugin-runner
  has stopped before continuing.
* mandos-to-cryptroot-unlock: New script to run plugin-runner and feed
  any password it gets into the "cryptroot-unlock" program.

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