/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.92 by Teddy Hogeborn
Updated year in copyright notices.
6
<!ENTITY TIMESTAMP "2012-01-01">
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>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
40
      <holder>Teddy Hogeborn</holder>
41
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
42
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
43
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
44
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
45
  
24.1.23 by Björn Påhlsson
Added manual pages for:
46
  <refmeta>
47
    <refentrytitle>&CONFNAME;</refentrytitle>
48
    <manvolnum>5</manvolnum>
49
  </refmeta>
50
  
51
  <refnamediv>
52
    <refname><filename>&CONFNAME;</filename></refname>
53
    <refpurpose>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
54
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
55
    </refpurpose>
56
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
57
  
24.1.23 by Björn Påhlsson
Added manual pages for:
58
  <refsynopsisdiv>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
59
    <synopsis>&CONFPATH;</synopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
60
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
61
  
24.1.23 by Björn Påhlsson
Added manual pages for:
62
  <refsect1 id="description">
63
    <title>DESCRIPTION</title>
64
    <para>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
65
      The file &CONFPATH; is a configuration file for <citerefentry
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
66
      ><refentrytitle>mandos</refentrytitle>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
      The file needs to list all clients that should be able to use
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
69
      the service.  All clients listed will be regarded as enabled,
70
      even if a client was disabled in a previous run of the server.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
71
    </para>
72
    <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
73
      The format starts with a <literal>[<replaceable>section
74
      header</replaceable>]</literal> which is either
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
75
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
76
      name</replaceable>]</literal>.  The <replaceable>client
77
      name</replaceable> can be anything, and is not tied to a host
78
      name.  Following the section header is any number of
79
      <quote><varname><replaceable>option</replaceable
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
80
      ></varname>=<replaceable>value</replaceable></quote> entries,
81
      with continuations in the style of RFC 822.  <quote><varname
82
      ><replaceable>option</replaceable></varname>: <replaceable
83
      >value</replaceable></quote> is also accepted.  Note that
84
      leading whitespace is removed from values.  Values can contain
85
      format strings which refer to other values in the same section,
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
86
      or values in the <quote>DEFAULT</quote> section (see <xref
87
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
88
      or <quote>;</quote> are ignored and may be used to provide
89
      comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
90
    </para>
91
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
92
  
93
  <refsect1 id="options">
94
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
95
    <para>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
96
      <emphasis>Note:</emphasis> all option values are subject to
97
      start time expansion, see <xref linkend="expansion"/>.
98
    </para>
99
    <para>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
100
      Unknown options are ignored.  The used options are as follows:
24.1.23 by Björn Påhlsson
Added manual pages for:
101
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
102
    
24.1.23 by Björn Påhlsson
Added manual pages for:
103
    <variablelist>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
104
      
24.1.23 by Björn Påhlsson
Added manual pages for:
105
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
106
	<term><option>approval_delay<literal> = </literal><replaceable
107
	>TIME</replaceable></option></term>
108
	<listitem>
109
	  <para>
110
	    This option is <emphasis>optional</emphasis>.
111
	  </para>
112
	  <para>
113
	    How long to wait for external approval before resorting to
114
	    use the <option>approved_by_default</option> value.  The
115
	    default is <quote>0s</quote>, i.e. not to wait.
116
	  </para>
117
	  <para>
118
	    The format of <replaceable>TIME</replaceable> is the same
119
	    as for <varname>timeout</varname> below.
120
	  </para>
121
	</listitem>
122
      </varlistentry>
123
      
124
      <varlistentry>
125
	<term><option>approval_duration<literal> = </literal
126
        ><replaceable>TIME</replaceable></option></term>
127
	<listitem>
128
	  <para>
129
	    This option is <emphasis>optional</emphasis>.
130
	  </para>
131
	  <para>
132
	    How long an external approval lasts.  The default is 1
133
	    second.
134
	  </para>
135
	  <para>
136
	    The format of <replaceable>TIME</replaceable> is the same
137
	    as for <varname>timeout</varname> below.
138
	  </para>
139
	</listitem>
140
      </varlistentry>
141
      
142
      <varlistentry>
143
	<term><option>approved_by_default<literal> = </literal
144
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
145
	  >true</literal> | <literal>on</literal> | <literal
146
	  >0</literal> | <literal>no</literal> | <literal
147
	  >false</literal> | <literal>off</literal> }</option></term>
148
	<listitem>
149
	  <para>
150
	    Whether to approve a client by default after
151
	    the <option>approval_delay</option>.  The default
152
	    is <quote>True</quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
153
	  </para>
154
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
155
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
156
      
24.1.23 by Björn Påhlsson
Added manual pages for:
157
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
158
	<term><option>checker<literal> = </literal><replaceable
159
	>COMMAND</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
160
	<listitem>
161
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
162
	    This option is <emphasis>optional</emphasis>.
163
	  </para>
164
	  <para>
24.1.23 by Björn Påhlsson
Added manual pages for:
165
	    This option allows you to override the default shell
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
166
	    command that the server will use to check if the client is
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
167
	    still up.  Any output of the command will be ignored, only
168
	    the exit code is checked:  If the exit code of the command
169
	    is zero, the client is considered up.  The command will be
170
	    run using <quote><command><filename>/bin/sh</filename>
171
	    <option>-c</option></command></quote>, so
172
	    <varname>PATH</varname> will be searched.  The default
173
	    value for the checker command is <quote><literal
174
	    ><command>fping</command> <option>-q</option> <option
237.2.20 by Teddy Hogeborn
Change the default value of the "checker" option command to make the
175
	    >--</option> %%(host)s</literal></quote>.
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
176
	  </para>
177
	  <para>
178
	    In addition to normal start time expansion, this option
179
	    will also be subject to runtime expansion; see <xref
180
	    linkend="expansion"/>.
24.1.23 by Björn Påhlsson
Added manual pages for:
181
	  </para>
182
	</listitem>
183
      </varlistentry>
184
      
185
      <varlistentry>
237.7.48 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Moved up "extended_timeout" to
186
	<term><option>extended_timeout<literal> = </literal><replaceable
187
	>TIME</replaceable></option></term>
188
	<listitem>
189
	  <para>
190
	    This option is <emphasis>optional</emphasis>.
191
	  </para>
192
	  <para>
193
	    Extended timeout is an added timeout that is given once
237.11.13 by Teddy Hogeborn
Miscellaneous fixes prompted by lintian:
194
	    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
195
	    The timeout is by default longer than the normal timeout,
196
	    and is used for handling the extra long downtime while a
197
	    machine is booting up.  Time to take into consideration
198
	    when changing this value is file system checks and quota
199
	    checks.  The default value is 15 minutes.
200
	  </para>
201
	  <para>
202
	    The format of <replaceable>TIME</replaceable> is the same
203
	    as for <varname>timeout</varname> below.
204
	  </para>
205
	</listitem>
206
      </varlistentry>
207
      
208
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
209
	<term><option>fingerprint<literal> = </literal
210
	><replaceable>HEXSTRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
211
	<listitem>
212
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
213
	    This option is <emphasis>required</emphasis>.
214
	  </para>
215
	  <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
216
	    This option sets the OpenPGP fingerprint that identifies
217
	    the public key that clients authenticate themselves with
218
	    through TLS.  The string needs to be in hexidecimal form,
219
	    but spaces or upper/lower case are not significant.
24.1.23 by Björn Påhlsson
Added manual pages for:
220
	  </para>
221
	</listitem>
222
      </varlistentry>
223
      
224
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
225
	<term><option><literal>host = </literal><replaceable
226
	>STRING</replaceable></option></term>
227
	<listitem>
228
	  <para>
229
	    This option is <emphasis>optional</emphasis>, but highly
230
	    <emphasis>recommended</emphasis> unless the
231
	    <option>checker</option> option is modified to a
232
	    non-standard value without <quote>%%(host)s</quote> in it.
233
	  </para>
234
	  <para>
235
	    Host name for this client.  This is not used by the server
236
	    directly, but can be, and is by default, used by the
237
	    checker.  See the <option>checker</option> option.
238
	  </para>
239
	</listitem>
240
      </varlistentry>
241
      
242
      <varlistentry>
243
	<term><option>interval<literal> = </literal><replaceable
244
	>TIME</replaceable></option></term>
245
	<listitem>
246
	  <para>
247
	    This option is <emphasis>optional</emphasis>.
248
	  </para>
249
	  <para>
250
	    How often to run the checker to confirm that a client is
251
	    still up.  <emphasis>Note:</emphasis> a new checker will
252
	    not be started if an old one is still running.  The server
253
	    will wait for a checker to complete until the below
254
	    <quote><varname>timeout</varname></quote> occurs, at which
255
	    time the client will be disabled, and any running checker
24.1.179 by Björn Påhlsson
New feature:
256
	    killed.  The default interval is 2 minutes.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
257
	  </para>
258
	  <para>
259
	    The format of <replaceable>TIME</replaceable> is the same
260
	    as for <varname>timeout</varname> below.
261
	  </para>
262
	</listitem>
263
      </varlistentry>
264
      
265
      <varlistentry>
266
	<term><option>secfile<literal> = </literal><replaceable
267
	>FILENAME</replaceable></option></term>
268
	<listitem>
269
	  <para>
270
	    This option is only used if <option>secret</option> is not
271
	    specified, in which case this option is
272
	    <emphasis>required</emphasis>.
273
	  </para>
274
	  <para>
275
	    Similar to the <option>secret</option>, except the secret
276
	    data is in an external file.  The contents of the file
277
	    should <emphasis>not</emphasis> be base64-encoded, but
278
	    will be sent to clients verbatim.
279
	  </para>
280
	  <para>
281
	    File names of the form <filename>~user/foo/bar</filename>
282
	    and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
283
	    are supported.
284
	  </para>
285
	</listitem>
286
      </varlistentry>
287
      
288
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
289
	<term><option>secret<literal> = </literal><replaceable
290
	>BASE64_ENCODED_DATA</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
291
	<listitem>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
292
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
293
	    If this option is not specified, the <option
294
	    >secfile</option> option is <emphasis>required</emphasis>
295
	    to be present.
296
	  </para>
297
	  <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
298
	    If present, this option must be set to a string of
299
	    base64-encoded binary data.  It will be decoded and sent
300
	    to the client matching the above
301
	    <option>fingerprint</option>.  This should, of course, be
302
	    OpenPGP encrypted data, decryptable only by the client.
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
303
	    The program <citerefentry><refentrytitle><command
304
	    >mandos-keygen</command></refentrytitle><manvolnum
305
	    >8</manvolnum></citerefentry> can, using its
306
	    <option>--password</option> option, be used to generate
307
	    this, if desired.
308
	  </para>
309
	  <para>
310
	    Note: this value of this option will probably be very
311
	    long.  A useful feature to avoid having unreadably-long
312
	    lines is that a line beginning with white space adds to
313
	    the value of the previous line, RFC 822-style.
314
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
315
	</listitem>
316
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
317
      
24.1.23 by Björn Påhlsson
Added manual pages for:
318
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
319
	<term><option>timeout<literal> = </literal><replaceable
237.2.186 by Teddy Hogeborn
Documentation changes:
320
	>TIME</replaceable></option></term>
321
	<listitem>
322
	  <para>
323
	    This option is <emphasis>optional</emphasis>.
324
	  </para>
325
	  <para>
237.7.49 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
326
	    The timeout is how long the server will wait, after a
327
	    successful checker run, until a client is disabled and not
328
	    allowed to get the data this server holds.  By default
329
	    Mandos will use 5 minutes.  See also the
330
	    <option>extended_timeout</option> option.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
331
	  </para>
332
	  <para>
333
	    The <replaceable>TIME</replaceable> is specified as a
334
	    space-separated number of values, each of which is a
335
	    number and a one-character suffix.  The suffix must be one
336
	    of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
337
	    <quote>h</quote>, and <quote>w</quote> for days, seconds,
338
	    minutes, hours, and weeks, respectively.  The values are
339
	    added together to give the total time value, so all of
340
	    <quote><literal>330s</literal></quote>,
341
	    <quote><literal>110s 110s 110s</literal></quote>, and
342
	    <quote><literal>5m 30s</literal></quote> will give a value
343
	    of five minutes and thirty seconds.
237.2.186 by Teddy Hogeborn
Documentation changes:
344
	  </para>
345
	</listitem>
346
      </varlistentry>
347
      
237.14.3 by Teddy Hogeborn
Make "enabled" a client config option.
348
      <varlistentry>
349
	<term><option>enabled<literal> = </literal>{ <literal
350
	>1</literal> | <literal>yes</literal> |	<literal>true</literal
351
	> | <literal >on</literal> | <literal>0</literal> | <literal
352
	>no</literal> | <literal>false</literal> | <literal
353
	>off</literal> }</option></term>
354
	<listitem>
355
	  <para>
356
	    Whether this client should be enabled by default.  The
357
	    default is <quote>true</quote>.
358
	  </para>
359
	</listitem>
360
      </varlistentry>
361
      
24.1.23 by Björn Påhlsson
Added manual pages for:
362
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
363
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
364
  
365
  <refsect1 id="expansion">
366
    <title>EXPANSION</title>
367
    <para>
368
      There are two forms of expansion: Start time expansion and
369
      runtime expansion.
370
    </para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
371
    <refsect2 id="start_time_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
372
      <title>START TIME EXPANSION</title>
373
      <para>
374
	Any string in an option value of the form
375
	<quote><literal>%(<replaceable>foo</replaceable>)s</literal
376
	></quote> will be replaced by the value of the option
377
	<varname>foo</varname> either in the same section, or, if it
378
	does not exist there, the <literal>[DEFAULT]</literal>
379
	section.  This is done at start time, when the configuration
380
	file is read.
381
      </para>
382
      <para>
383
	Note that this means that, in order to include an actual
384
	percent character (<quote>%</quote>) in an option value, two
385
	percent characters in a row (<quote>%%</quote>) must be
386
	entered.
387
      </para>
388
    </refsect2>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
389
    <refsect2 id="runtime_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
390
      <title>RUNTIME EXPANSION</title>
391
      <para>
392
	This is currently only done for the <varname>checker</varname>
393
	option.
394
      </para>
395
      <para>
396
	Any string in an option value of the form
397
	<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
	></quote> will be replaced by the value of the attribute
399
	<varname>foo</varname> of the internal
237.2.212 by teddy at bsnet
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
400
	<quote><classname>Client</classname></quote> object in the
401
	Mandos server.  The currently allowed values for
402
	<replaceable>foo</replaceable> are:
403
	<quote><literal>approval_delay</literal></quote>,
404
	<quote><literal>approval_duration</literal></quote>,
405
	<quote><literal>created</literal></quote>,
406
	<quote><literal>enabled</literal></quote>,
407
	<quote><literal>fingerprint</literal></quote>,
408
	<quote><literal>host</literal></quote>,
409
	<quote><literal>interval</literal></quote>,
410
	<quote><literal>last_approval_request</literal></quote>,
411
	<quote><literal>last_checked_ok</literal></quote>,
412
	<quote><literal>last_enabled</literal></quote>,
413
	<quote><literal>name</literal></quote>,
414
	<quote><literal>timeout</literal></quote>, and, if using
415
	D-Bus, <quote><literal>dbus_object_path</literal></quote>.
416
	See the source code for details.  <emphasis role="strong"
417
	>Currently, <emphasis>none</emphasis> of these attributes
418
	except <quote><literal>host</literal></quote> are guaranteed
419
	to be valid in future versions.</emphasis> Therefore, please
420
	let the authors know of any attributes that are useful so they
421
	may be preserved to any new versions of this software.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
422
      </para>
423
      <para>
424
	Note that this means that, in order to include an actual
425
	percent character (<quote>%</quote>) in a
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
426
	<varname>checker</varname> option, <emphasis>four</emphasis>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
427
	percent characters in a row (<quote>%%%%</quote>) must be
428
	entered.  Also, a bad format here will lead to an immediate
429
	but <emphasis>silent</emphasis> run-time fatal exit; debug
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
430
	mode is needed to expose an error of this kind.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
431
      </para>
432
    </refsect2>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
433
    
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
434
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
435
  
436
  <refsect1 id="files">
437
    <title>FILES</title>
438
    <para>
439
      The file described here is &CONFPATH;
440
    </para>
441
  </refsect1>
442
  
443
  <refsect1 id="bugs">
444
    <title>BUGS</title>
445
    <para>
446
      The format for specifying times for <varname>timeout</varname>
447
      and <varname>interval</varname> is not very good.
448
    </para>
449
    <para>
450
      The difference between
451
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
452
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
453
      obscure.
454
    </para>
455
  </refsect1>
456
  
457
  <refsect1 id="example">
458
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
459
    <informalexample>
460
      <programlisting>
461
[DEFAULT]
24.1.179 by Björn Påhlsson
New feature:
462
timeout = 5m
463
interval = 2m
237.2.20 by Teddy Hogeborn
Change the default value of the "checker" option command to make the
464
checker = fping -q -- %%(host)s
24.1.23 by Björn Påhlsson
Added manual pages for:
465
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
466
# Client "foo"
467
[foo]
24.1.23 by Björn Påhlsson
Added manual pages for:
468
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
469
secret =
24.1.24 by Björn Påhlsson
minor edits
470
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
471
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
472
        Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
473
        3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
474
        Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
475
        QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
476
        t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
477
        3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
478
        dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
479
        WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
480
        zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
481
        vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
482
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
483
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
484
        QlnHIvPzEArRQLo=
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
485
host = foo.example.org
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
486
interval = 1m
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
487
488
# Client "bar"
489
[bar]
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
491
secfile = /etc/mandos/bar-secret
492
timeout = 15m
237.2.186 by Teddy Hogeborn
Documentation changes:
493
approved_by_default = False
494
approval_delay = 30s
24.1.23 by Björn Påhlsson
Added manual pages for:
495
      </programlisting>
496
    </informalexample>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
497
  </refsect1>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
498
  
499
  <refsect1 id="see_also">
500
    <title>SEE ALSO</title>
501
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
502
      <citerefentry><refentrytitle>intro</refentrytitle>
503
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
504
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
505
      <manvolnum>8</manvolnum></citerefentry>,
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
507
      <manvolnum>5</manvolnum></citerefentry>,
508
      <citerefentry><refentrytitle>mandos</refentrytitle>
509
      <manvolnum>8</manvolnum></citerefentry>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
510
    </para>
511
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
512
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
513
<!-- Local Variables: -->
514
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
515
<!-- time-stamp-end: "[\"']>" -->
516
<!-- time-stamp-format: "%:y-%02m-%02d" -->
517
<!-- End: -->