/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
1
<?xml version="1.0" encoding="UTF-8"?>
24.1.23 by Björn Påhlsson
Added manual pages for:
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
24.1.24 by Björn Påhlsson
minor edits
4
<!ENTITY CONFNAME "mandos-clients.conf">
24.1.23 by Björn Påhlsson
Added manual pages for:
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
6
<!ENTITY TIMESTAMP "2018-02-08">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
24.1.23 by Björn Påhlsson
Added manual pages for:
9
]>
10
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
12
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <title>Mandos Manual</title>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
15
    <productname>Mandos</productname>
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
16
    <productnumber>&version;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
17
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
18
    <authorgroup>
19
      <author>
20
	<firstname>Björn</firstname>
21
	<surname>Påhlsson</surname>
22
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
23
	  <email>belorn@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
24
	</address>
25
      </author>
26
      <author>
27
	<firstname>Teddy</firstname>
28
	<surname>Hogeborn</surname>
29
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
30
	  <email>teddy@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
31
	</address>
32
      </author>
33
    </authorgroup>
34
    <copyright>
35
      <year>2008</year>
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
36
      <year>2009</year>
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
37
      <year>2010</year>
237.7.14 by Teddy Hogeborn
Update copyright year to "2011" wherever appropriate.
38
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
39
      <year>2012</year>
237.7.326 by Teddy Hogeborn
Update copyright year.
40
      <year>2013</year>
41
      <year>2014</year>
42
      <year>2015</year>
237.7.355 by Teddy Hogeborn
Update copyright year.
43
      <year>2016</year>
237.7.447 by Teddy Hogeborn
Update copyright year to 2017
44
      <year>2017</year>
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
45
      <year>2018</year>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
46
      <holder>Teddy Hogeborn</holder>
47
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
48
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
49
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
50
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
51
  
24.1.23 by Björn Påhlsson
Added manual pages for:
52
  <refmeta>
53
    <refentrytitle>&CONFNAME;</refentrytitle>
54
    <manvolnum>5</manvolnum>
55
  </refmeta>
56
  
57
  <refnamediv>
58
    <refname><filename>&CONFNAME;</filename></refname>
59
    <refpurpose>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
60
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
61
    </refpurpose>
62
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
63
  
24.1.23 by Björn Påhlsson
Added manual pages for:
64
  <refsynopsisdiv>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
65
    <synopsis>&CONFPATH;</synopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
66
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
67
  
24.1.23 by Björn Påhlsson
Added manual pages for:
68
  <refsect1 id="description">
69
    <title>DESCRIPTION</title>
70
    <para>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
71
      The file &CONFPATH; is a configuration file for <citerefentry
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
72
      ><refentrytitle>mandos</refentrytitle>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
      The file needs to list all clients that should be able to use
237.7.94 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
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.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
82
    </para>
83
    <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
84
      The format starts with a <literal>[<replaceable>section
85
      header</replaceable>]</literal> which is either
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
86
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
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
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
91
      ></varname>=<replaceable>value</replaceable></quote> entries,
92
      with continuations in the style of RFC 822.  <quote><varname
93
      ><replaceable>option</replaceable></varname>: <replaceable
94
      >value</replaceable></quote> is also accepted.  Note that
95
      leading whitespace is removed from values.  Values can contain
96
      format strings which refer to other values in the same section,
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
101
    </para>
102
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
103
  
104
  <refsect1 id="options">
105
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
106
    <para>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
107
      <emphasis>Note:</emphasis> all option values are subject to
108
      start time expansion, see <xref linkend="expansion"/>.
109
    </para>
110
    <para>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
111
      Unknown options are ignored.  The used options are as follows:
24.1.23 by Björn Påhlsson
Added manual pages for:
112
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
113
    
24.1.23 by Björn Påhlsson
Added manual pages for:
114
    <variablelist>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
115
      
24.1.23 by Björn Påhlsson
Added manual pages for:
116
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
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
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
126
	    default is <quote>PT0S</quote>, i.e. not to wait.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
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>.
24.1.23 by Björn Påhlsson
Added manual pages for:
164
	  </para>
165
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
166
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
167
      
24.1.23 by Björn Påhlsson
Added manual pages for:
168
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
169
	<term><option>checker<literal> = </literal><replaceable
170
	>COMMAND</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
171
	<listitem>
172
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
173
	    This option is <emphasis>optional</emphasis>.
174
	  </para>
175
	  <para>
237.7.138 by Teddy Hogeborn
* mandos: Change comment.
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>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
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
237.7.256 by Teddy Hogeborn
mandos-keygen: Generate "checker" option to use SSH fingerprints.
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.
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
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"/>.
24.1.23 by Björn Påhlsson
Added manual pages for:
198
	  </para>
199
	</listitem>
200
      </varlistentry>
201
      
202
      <varlistentry>
237.7.48 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Moved up "extended_timeout" to
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
237.11.13 by Teddy Hogeborn
Miscellaneous fixes prompted by lintian:
211
	    after a password has been sent successfully to a client.
237.7.48 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Moved up "extended_timeout" to
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>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
226
	<term><option>fingerprint<literal> = </literal
227
	><replaceable>HEXSTRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
228
	<listitem>
229
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
230
	    This option is <emphasis>required</emphasis>.
231
	  </para>
232
	  <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
233
	    This option sets the OpenPGP fingerprint that identifies
234
	    the public key that clients authenticate themselves with
237.7.407 by Teddy Hogeborn
Fix typo in mandos-clients.conf(5).
235
	    through TLS.  The string needs to be in hexadecimal form,
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
236
	    but spaces or upper/lower case are not significant.
24.1.23 by Björn Påhlsson
Added manual pages for:
237
	  </para>
238
	</listitem>
239
      </varlistentry>
240
      
241
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
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>
266
	  <para>
267
	    How often to run the checker to confirm that a client is
268
	    still up.  <emphasis>Note:</emphasis> a new checker will
269
	    not be started if an old one is still running.  The server
270
	    will wait for a checker to complete until the below
271
	    <quote><varname>timeout</varname></quote> occurs, at which
272
	    time the client will be disabled, and any running checker
24.1.179 by Björn Påhlsson
New feature:
273
	    killed.  The default interval is 2 minutes.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
274
	  </para>
275
	  <para>
276
	    The format of <replaceable>TIME</replaceable> is the same
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>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
306
	<term><option>secret<literal> = </literal><replaceable
307
	>BASE64_ENCODED_DATA</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
308
	<listitem>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
309
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
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>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
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.
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
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>
24.1.23 by Björn Påhlsson
Added manual pages for:
332
	</listitem>
333
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
334
      
24.1.23 by Björn Påhlsson
Added manual pages for:
335
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
336
	<term><option>timeout<literal> = </literal><replaceable
237.2.186 by Teddy Hogeborn
Documentation changes:
337
	>TIME</replaceable></option></term>
338
	<listitem>
339
	  <para>
340
	    This option is <emphasis>optional</emphasis>.
341
	  </para>
342
	  <para>
237.7.49 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
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.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
348
	  </para>
349
	  <para>
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
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.
237.2.186 by Teddy Hogeborn
Documentation changes:
356
	  </para>
357
	</listitem>
358
      </varlistentry>
359
      
237.14.3 by Teddy Hogeborn
Make "enabled" a client config option.
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>
373
      
24.1.23 by Björn Påhlsson
Added manual pages for:
374
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
375
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
376
  
377
  <refsect1 id="expansion">
378
    <title>EXPANSION</title>
379
    <para>
380
      There are two forms of expansion: Start time expansion and
381
      runtime expansion.
382
    </para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
383
    <refsect2 id="start_time_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
384
      <title>START TIME EXPANSION</title>
385
      <para>
386
	Any string in an option value of the form
387
	<quote><literal>%(<replaceable>foo</replaceable>)s</literal
388
	></quote> will be replaced by the value of the option
389
	<varname>foo</varname> either in the same section, or, if it
390
	does not exist there, the <literal>[DEFAULT]</literal>
391
	section.  This is done at start time, when the configuration
392
	file is read.
393
      </para>
394
      <para>
395
	Note that this means that, in order to include an actual
396
	percent character (<quote>%</quote>) in an option value, two
397
	percent characters in a row (<quote>%%</quote>) must be
398
	entered.
399
      </para>
400
    </refsect2>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
401
    <refsect2 id="runtime_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
402
      <title>RUNTIME EXPANSION</title>
403
      <para>
404
	This is currently only done for the <varname>checker</varname>
405
	option.
406
      </para>
407
      <para>
408
	Any string in an option value of the form
409
	<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
	></quote> will be replaced by the value of the attribute
411
	<varname>foo</varname> of the internal
237.2.212 by teddy at bsnet
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
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>,
237.7.132 by Teddy Hogeborn
* mandos (Client.runtime_expansions): Add "expires" and (bug fix)
419
	<quote><literal>expires</literal></quote>,
237.2.212 by teddy at bsnet
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
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.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
435
      </para>
436
      <para>
437
	Note that this means that, in order to include an actual
438
	percent character (<quote>%</quote>) in a
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
439
	<varname>checker</varname> option, <emphasis>four</emphasis>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
440
	percent characters in a row (<quote>%%%%</quote>) must be
441
	entered.  Also, a bad format here will lead to an immediate
442
	but <emphasis>silent</emphasis> run-time fatal exit; debug
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
443
	mode is needed to expose an error of this kind.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
444
      </para>
445
    </refsect2>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
446
    
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
447
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
448
  
449
  <refsect1 id="files">
450
    <title>FILES</title>
451
    <para>
452
      The file described here is &CONFPATH;
453
    </para>
454
  </refsect1>
455
  
456
  <refsect1 id="bugs">
457
    <title>BUGS</title>
458
    <para>
459
      The format for specifying times for <varname>timeout</varname>
460
      and <varname>interval</varname> is not very good.
461
    </para>
462
    <para>
463
      The difference between
464
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
465
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
466
      obscure.
467
    </para>
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
468
    <xi:include href="bugs.xml"/>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
469
  </refsect1>
470
  
471
  <refsect1 id="example">
472
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
473
    <informalexample>
474
      <programlisting>
475
[DEFAULT]
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
476
timeout = PT5M
477
interval = PT2M
237.2.20 by Teddy Hogeborn
Change the default value of the "checker" option command to make the
478
checker = fping -q -- %%(host)s
24.1.23 by Björn Påhlsson
Added manual pages for:
479
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
480
# Client "foo"
481
[foo]
24.1.23 by Björn Påhlsson
Added manual pages for:
482
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
483
secret =
24.1.24 by Björn Påhlsson
minor edits
484
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
485
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
486
        Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
487
        3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
488
        Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
489
        QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
490
        t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
491
        3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
492
        dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
493
        WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
494
        zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
495
        vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
496
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
497
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
        QlnHIvPzEArRQLo=
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
499
host = foo.example.org
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
500
interval = PT1M
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
501
502
# Client "bar"
503
[bar]
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
505
secfile = /etc/mandos/bar-secret
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
506
timeout = PT15M
237.2.186 by Teddy Hogeborn
Documentation changes:
507
approved_by_default = False
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
508
approval_delay = PT30S
24.1.23 by Björn Påhlsson
Added manual pages for:
509
      </programlisting>
510
    </informalexample>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
511
  </refsect1>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
512
  
513
  <refsect1 id="see_also">
514
    <title>SEE ALSO</title>
515
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
516
      <citerefentry><refentrytitle>intro</refentrytitle>
517
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
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>
237.7.138 by Teddy Hogeborn
* mandos: Change comment.
523
      <manvolnum>8</manvolnum></citerefentry>,
524
      <citerefentry><refentrytitle>fping</refentrytitle>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
525
      <manvolnum>8</manvolnum></citerefentry>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
526
    </para>
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
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>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
541
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
542
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
543
<!-- Local Variables: -->
544
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
545
<!-- time-stamp-end: "[\"']>" -->
546
<!-- time-stamp-format: "%:y-%02m-%02d" -->
547
<!-- End: -->