/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: 2017-02-23 19:11:11 UTC
  • 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'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
7
4
<!ENTITY CONFNAME "mandos-clients.conf">
8
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
 
6
<!ENTITY TIMESTAMP "2017-02-23">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
9
9
]>
10
10
 
11
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
12
  <refentryinfo>
13
 
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>&CONFNAME;</productname>
16
 
    <productnumber>&VERSION;</productnumber>
 
13
    <title>Mandos Manual</title>
 
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
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>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
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
      <holder>Teddy Hogeborn</holder>
 
46
      <holder>Björn Påhlsson</holder>
36
47
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
48
    <xi:include href="legalnotice.xml"/>
60
49
  </refentryinfo>
61
 
 
 
50
  
62
51
  <refmeta>
63
52
    <refentrytitle>&CONFNAME;</refentrytitle>
64
53
    <manvolnum>5</manvolnum>
67
56
  <refnamediv>
68
57
    <refname><filename>&CONFNAME;</filename></refname>
69
58
    <refpurpose>
70
 
      Configuration file for Mandos clients
 
59
      Configuration file for the Mandos server
71
60
    </refpurpose>
72
61
  </refnamediv>
73
 
 
 
62
  
74
63
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
64
    <synopsis>&CONFPATH;</synopsis>
78
65
  </refsynopsisdiv>
79
 
 
 
66
  
80
67
  <refsect1 id="description">
81
68
    <title>DESCRIPTION</title>
82
69
    <para>
83
 
      The file &CONFPATH; is the configuration file for mandos where
84
 
      each client that will be abel to use the service need to be
85
 
      specified. The configuration file is looked on at the startup of
86
 
      the service, so to reenable timedout clients one need to only
87
 
      restart the server. The format starts with a section under []
88
 
      which is eather <literal>[DEFAULT]</literal> or a client
89
 
      name. Values is set through the use of VAR = VALUE pair. Values
90
 
      may not be empty.
91
 
    </para>
92
 
  </refsect1>
93
 
 
94
 
  <refsect1 id="default">
95
 
    <title>DEFAULTS</title>
96
 
    <para>
97
 
      The paramters for <literal>[DEFAULT]</literal> are:
98
 
    </para>
99
 
 
100
 
    <variablelist>
101
 
      
102
 
      <varlistentry>
103
 
        <term><literal>timeout</literal></term>
104
 
        <listitem>
105
 
          <para>
106
 
            This option allows you to override the default timeout
107
 
            that clients will get. By default mandos will use 1hr.
108
 
          </para>
109
 
        </listitem>
110
 
      </varlistentry>
111
 
 
112
 
      <varlistentry>
113
 
        <term><literal>interval</literal></term>
114
 
        <listitem>
115
 
          <para>
116
 
            This option allows you to override the default interval
117
 
            used between checkups for disconnected clients. By default
118
 
            mandos will use 5m.
119
 
          </para>
120
 
        </listitem>
121
 
      </varlistentry>      
122
 
 
123
 
      <varlistentry>
124
 
        <term><literal>checker</literal></term>
125
 
        <listitem>
126
 
          <para>
127
 
            This option allows you to override the default shell
128
 
            command that the server will use to check up if the client
129
 
            is still up. By default mandos will "fping -q -- %%(host)s"
130
 
          </para>
131
 
        </listitem>
132
 
      </varlistentry>
133
 
      
134
 
    </variablelist>
135
 
  </refsect1>
136
 
 
137
 
  <refsect1 id="clients">
138
 
    <title>CLIENTS</title>
139
 
    <para>
140
 
      The paramters for clients are:
141
 
    </para>
142
 
 
143
 
    <variablelist>
144
 
      
145
 
      <varlistentry>
146
 
        <term><literal>fingerprint</literal></term>
147
 
        <listitem>
148
 
          <para>
149
 
            This option sets the openpgp fingerprint that identifies
150
 
            the public certificate that clients authenticates themself
151
 
            through gnutls. The string need to be in hex-decimal form.
152
 
          </para>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
 
      <varlistentry>
157
 
        <term><literal>secret</literal></term>
158
 
        <listitem>
159
 
          <para>
160
 
            Base 64 encoded OpenPGP encrypted password encrypted by
161
 
            the clients openpgp certificate.
162
 
          </para>
163
 
        </listitem>
164
 
      </varlistentry>
165
 
 
166
 
      <varlistentry>
167
 
        <term><literal>secfile</literal></term>
168
 
        <listitem>
169
 
          <para>
170
 
            Base 64 encoded OpenPGP encrypted password encrypted by
171
 
            the clients openpgp certificate as a binary file.
172
 
          </para>
173
 
        </listitem>
174
 
      </varlistentry>
175
 
 
176
 
      <varlistentry>
177
 
        <term><literal>host</literal></term>
178
 
        <listitem>
179
 
          <para>
180
 
            Host name that can be used in for checking that the client is up.
181
 
          </para>
182
 
        </listitem>
183
 
      </varlistentry>
184
 
 
185
 
      <varlistentry>
186
 
        <term><literal>checker</literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            Shell command that the server will use to check up if a
190
 
            client is still up.
191
 
          </para>
192
 
        </listitem>
193
 
      </varlistentry>      
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>timeout</literal></term>
197
 
        <listitem>
198
 
          <para>
199
 
            Duration that a client can be down whitout be removed from
200
 
            the client list.
201
 
          </para>
202
 
        </listitem>
203
 
      </varlistentry> 
204
 
      
205
 
    </variablelist>
206
 
  </refsect1>  
207
 
 
208
 
  <refsect1 id="examples">
209
 
    <title>EXAMPLES</title>
 
70
      The file &CONFPATH; is a configuration file for <citerefentry
 
71
      ><refentrytitle>mandos</refentrytitle>
 
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.
 
81
    </para>
 
82
    <para>
 
83
      The format starts with a <literal>[<replaceable>section
 
84
      header</replaceable>]</literal> which is either
 
85
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
 
86
      name</replaceable>]</literal>.  The <replaceable>client
 
87
      name</replaceable> can be anything, and is not tied to a host
 
88
      name.  Following the section header is any number of
 
89
      <quote><varname><replaceable>option</replaceable
 
90
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
91
      with continuations in the style of RFC 822.  <quote><varname
 
92
      ><replaceable>option</replaceable></varname>: <replaceable
 
93
      >value</replaceable></quote> is also accepted.  Note that
 
94
      leading whitespace is removed from values.  Values can contain
 
95
      format strings which refer to other values in the same section,
 
96
      or values in the <quote>DEFAULT</quote> section (see <xref
 
97
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
 
98
      or <quote>;</quote> are ignored and may be used to provide
 
99
      comments.
 
100
    </para>
 
101
  </refsect1>
 
102
  
 
103
  <refsect1 id="options">
 
104
    <title>OPTIONS</title>
 
105
    <para>
 
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
    
 
113
    <variablelist>
 
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
            <quote><command><filename>/bin/sh</filename>
 
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.
 
192
          </para>
 
193
          <para>
 
194
            In addition to normal start time expansion, this option
 
195
            will also be subject to runtime expansion; see <xref
 
196
            linkend="expansion"/>.
 
197
          </para>
 
198
        </listitem>
 
199
      </varlistentry>
 
200
      
 
201
      <varlistentry>
 
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>
 
231
          <para>
 
232
            This option sets the OpenPGP fingerprint that identifies
 
233
            the public key that clients authenticate themselves with
 
234
            through TLS.  The string needs to be in hexadecimal form,
 
235
            but spaces or upper/lower case are not significant.
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
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>
 
313
          <para>
 
314
            If present, this option must be set to a string of
 
315
            base64-encoded binary data.  It will be decoded and sent
 
316
            to the client matching the above
 
317
            <option>fingerprint</option>.  This should, of course, be
 
318
            OpenPGP encrypted data, decryptable only by the client.
 
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>
 
372
      
 
373
    </variablelist>
 
374
  </refsect1>
 
375
  
 
376
  <refsect1 id="expansion">
 
377
    <title>EXPANSION</title>
 
378
    <para>
 
379
      There are two forms of expansion: Start time expansion and
 
380
      runtime expansion.
 
381
    </para>
 
382
    <refsect2 id="start_time_expansion">
 
383
      <title>START TIME EXPANSION</title>
 
384
      <para>
 
385
        Any string in an option value of the form
 
386
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
 
387
        ></quote> will be replaced by the value of the option
 
388
        <varname>foo</varname> either in the same section, or, if it
 
389
        does not exist there, the <literal>[DEFAULT]</literal>
 
390
        section.  This is done at start time, when the configuration
 
391
        file is read.
 
392
      </para>
 
393
      <para>
 
394
        Note that this means that, in order to include an actual
 
395
        percent character (<quote>%</quote>) in an option value, two
 
396
        percent characters in a row (<quote>%%</quote>) must be
 
397
        entered.
 
398
      </para>
 
399
    </refsect2>
 
400
    <refsect2 id="runtime_expansion">
 
401
      <title>RUNTIME EXPANSION</title>
 
402
      <para>
 
403
        This is currently only done for the <varname>checker</varname>
 
404
        option.
 
405
      </para>
 
406
      <para>
 
407
        Any string in an option value of the form
 
408
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
 
409
        ></quote> will be replaced by the value of the attribute
 
410
        <varname>foo</varname> of the internal
 
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.
 
434
      </para>
 
435
      <para>
 
436
        Note that this means that, in order to include an actual
 
437
        percent character (<quote>%</quote>) in a
 
438
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
439
        percent characters in a row (<quote>%%%%</quote>) must be
 
440
        entered.  Also, a bad format here will lead to an immediate
 
441
        but <emphasis>silent</emphasis> run-time fatal exit; debug
 
442
        mode is needed to expose an error of this kind.
 
443
      </para>
 
444
    </refsect2>
 
445
    
 
446
  </refsect1>
 
447
  
 
448
  <refsect1 id="files">
 
449
    <title>FILES</title>
 
450
    <para>
 
451
      The file described here is &CONFPATH;
 
452
    </para>
 
453
  </refsect1>
 
454
  
 
455
  <refsect1 id="bugs">
 
456
    <title>BUGS</title>
 
457
    <para>
 
458
      The format for specifying times for <varname>timeout</varname>
 
459
      and <varname>interval</varname> is not very good.
 
460
    </para>
 
461
    <para>
 
462
      The difference between
 
463
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
 
464
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
 
465
      obscure.
 
466
    </para>
 
467
    <xi:include href="bugs.xml"/>
 
468
  </refsect1>
 
469
  
 
470
  <refsect1 id="example">
 
471
    <title>EXAMPLE</title>
210
472
    <informalexample>
211
473
      <programlisting>
212
474
[DEFAULT]
213
 
timeout = 1h
214
 
interval = 5m
 
475
timeout = PT5M
 
476
interval = PT2M
215
477
checker = fping -q -- %%(host)s
216
478
 
217
 
[example_client]
 
479
# Client "foo"
 
480
[foo]
218
481
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
219
 
 
220
482
secret =
221
483
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
222
484
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
233
495
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
234
496
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
235
497
        QlnHIvPzEArRQLo=
236
 
        =iHhv
 
498
host = foo.example.org
 
499
interval = PT1M
237
500
 
238
 
host = localhost
239
 
interval = 5m
 
501
# Client "bar"
 
502
[bar]
 
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
 
504
secfile = /etc/mandos/bar-secret
 
505
timeout = PT15M
 
506
approved_by_default = False
 
507
approval_delay = PT30S
240
508
      </programlisting>
241
509
    </informalexample>
242
 
  </refsect1>  
 
510
  </refsect1>
243
511
  
244
 
  <refsect1 id="files">
245
 
    <title>FILES</title>
 
512
  <refsect1 id="see_also">
 
513
    <title>SEE ALSO</title>
246
514
    <para>
247
 
      The file described here is &CONFPATH;
 
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>
248
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>
249
540
  </refsect1>
250
541
</refentry>
 
542
<!-- Local Variables: -->
 
543
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
544
<!-- time-stamp-end: "[\"']>" -->
 
545
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
546
<!-- End: -->