/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: 2024-09-08 07:15:13 UTC
  • Revision ID: teddy@recompile.se-20240908071513-2jnx7ja8hlct42hl
Minor fix for manual Makefile uninstallations

If the Mandos systemd unit file was not installed, it was still
removed by the "purge-server" target.  If systemd is not installed,
this could mean removal of "mandos.service" from the root directory.

(Note: this was *not* used by the Debian package as a method of
uninstallation; this was only ever done by the Makefile if "make
purge-server" was called by hand.  And a "mandos.service" file was
presumably also unlikely to exist in the root directory.)

* Makefile (purge-server): Only remove systemd service file
  "mandos.service" if the same conditions exist which permitted its
  initial installation in the "install-server" target.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
18
21
        <surname>Påhlsson</surname>
19
22
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
21
24
        </address>
22
25
      </author>
23
26
      <author>
24
27
        <firstname>Teddy</firstname>
25
28
        <surname>Hogeborn</surname>
26
29
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
28
31
        </address>
29
32
      </author>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
 
43
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
33
47
      <holder>Teddy Hogeborn</holder>
34
48
      <holder>Björn Påhlsson</holder>
35
49
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
50
    <xi:include href="legalnotice.xml"/>
59
51
  </refentryinfo>
60
 
 
 
52
  
61
53
  <refmeta>
62
54
    <refentrytitle>&CONFNAME;</refentrytitle>
63
55
    <manvolnum>5</manvolnum>
69
61
      Configuration file for the Mandos server
70
62
    </refpurpose>
71
63
  </refnamediv>
72
 
 
 
64
  
73
65
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
66
    <synopsis>&CONFPATH;</synopsis>
77
67
  </refsynopsisdiv>
78
 
 
 
68
  
79
69
  <refsect1 id="description">
80
70
    <title>DESCRIPTION</title>
81
71
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
72
      The file &CONFPATH; is a configuration file for <citerefentry
83
73
      ><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
 
      where each client that will be able to use the service needs to
86
 
      be listed.  All clients listed will be regarded as valid, even
87
 
      if a client was declared invalid in a previous run of the
88
 
      server.
 
74
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
 
75
      The file needs to list all clients that should be able to use
 
76
      the service.  The settings in this file can be overridden by
 
77
      runtime changes to the server, which it saves across restarts.
 
78
      (See the section called <quote>PERSISTENT STATE</quote> in
 
79
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
80
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
81
      >changes</emphasis> to this file (including adding and removing
 
82
      clients) will, at startup, override changes done during runtime.
89
83
    </para>
90
84
    <para>
91
85
      The format starts with a <literal>[<replaceable>section
111
105
  <refsect1 id="options">
112
106
    <title>OPTIONS</title>
113
107
    <para>
114
 
      The possible options are:
115
 
    </para>
116
 
 
 
108
      <emphasis>Note:</emphasis> all option values are subject to
 
109
      start time expansion, see <xref linkend="expansion"/>.
 
110
    </para>
 
111
    <para>
 
112
      Unknown options are ignored.  The used options are as follows:
 
113
    </para>
 
114
    
117
115
    <variablelist>
118
 
 
119
 
      <varlistentry>
120
 
        <term><literal><varname>timeout</varname></literal></term>
121
 
        <listitem>
122
 
          <synopsis><literal>timeout = </literal><replaceable
123
 
          >TIME</replaceable>
124
 
          </synopsis>
125
 
          <para>
126
 
            The timeout is how long the server will wait for a
127
 
            successful checker run until a client is considered
128
 
            invalid - that is, ineligible to get the data this server
129
 
            holds.  By default Mandos will use 1 hour.
130
 
          </para>
131
 
          <para>
132
 
            The <replaceable>TIME</replaceable> is specified as a
133
 
            space-separated number of values, each of which is a
134
 
            number and a one-character suffix.  The suffix must be one
135
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
136
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
137
 
            minutes, hours, and weeks, respectively.  The values are
138
 
            added together to give the total time value, so all of
139
 
            <quote><literal>330s</literal></quote>,
140
 
            <quote><literal>110s 110s 110s</literal></quote>, and
141
 
            <quote><literal>5m 30s</literal></quote> will give a value
142
 
            of five minutes and thirty seconds.
143
 
          </para>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
147
 
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
149
 
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
 
116
      
 
117
      <varlistentry>
 
118
        <term><option>approval_delay<literal> = </literal><replaceable
 
119
        >TIME</replaceable></option></term>
 
120
        <listitem>
 
121
          <para>
 
122
            This option is <emphasis>optional</emphasis>.
 
123
          </para>
 
124
          <para>
 
125
            How long to wait for external approval before resorting to
 
126
            use the <option>approved_by_default</option> value.  The
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
 
128
          </para>
 
129
          <para>
 
130
            The format of <replaceable>TIME</replaceable> is the same
 
131
            as for <varname>timeout</varname> below.
 
132
          </para>
 
133
        </listitem>
 
134
      </varlistentry>
 
135
      
 
136
      <varlistentry>
 
137
        <term><option>approval_duration<literal> = </literal
 
138
        ><replaceable>TIME</replaceable></option></term>
 
139
        <listitem>
 
140
          <para>
 
141
            This option is <emphasis>optional</emphasis>.
 
142
          </para>
 
143
          <para>
 
144
            How long an external approval lasts.  The default is 1
 
145
            second.
 
146
          </para>
 
147
          <para>
 
148
            The format of <replaceable>TIME</replaceable> is the same
 
149
            as for <varname>timeout</varname> below.
 
150
          </para>
 
151
        </listitem>
 
152
      </varlistentry>
 
153
      
 
154
      <varlistentry>
 
155
        <term><option>approved_by_default<literal> = </literal
 
156
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
157
          >true</literal> | <literal>on</literal> | <literal
 
158
          >0</literal> | <literal>no</literal> | <literal
 
159
          >false</literal> | <literal>off</literal> }</option></term>
 
160
        <listitem>
 
161
          <para>
 
162
            Whether to approve a client by default after
 
163
            the <option>approval_delay</option>.  The default
 
164
            is <quote>True</quote>.
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
      
 
169
      <varlistentry>
 
170
        <term><option>checker<literal> = </literal><replaceable
 
171
        >COMMAND</replaceable></option></term>
 
172
        <listitem>
 
173
          <para>
 
174
            This option is <emphasis>optional</emphasis>.
 
175
          </para>
 
176
          <para>
 
177
            This option overrides the default shell command that the
 
178
            server will use to check if the client is still up.  Any
 
179
            output of the command will be ignored, only the exit code
 
180
            is checked:  If the exit code of the command is zero, the
 
181
            client is considered up.  The command will be run using
 
182
            <quote><command><filename>/bin/sh</filename>
 
183
            <option>-c</option></command></quote>, so
 
184
            <varname>PATH</varname> will be searched.  The default
 
185
            value for the checker command is <quote><literal
 
186
            ><command>fping</command> <option>-q</option> <option
 
187
            >--</option> %%(host)s</literal></quote>.  Note that
 
188
            <command>mandos-keygen</command>, when generating output
 
189
            to be inserted into this file, normally looks for an SSH
 
190
            server on the Mandos client, and, if it finds one, outputs
 
191
            a <option>checker</option> option to check for the
 
192
            client’s SSH key fingerprint – this is more secure against
 
193
            spoofing.
 
194
          </para>
 
195
          <para>
 
196
            In addition to normal start time expansion, this option
 
197
            will also be subject to runtime expansion; see <xref
 
198
            linkend="expansion"/>.
 
199
          </para>
 
200
        </listitem>
 
201
      </varlistentry>
 
202
      
 
203
      <varlistentry>
 
204
        <term><option>extended_timeout<literal> = </literal><replaceable
 
205
        >TIME</replaceable></option></term>
 
206
        <listitem>
 
207
          <para>
 
208
            This option is <emphasis>optional</emphasis>.
 
209
          </para>
 
210
          <para>
 
211
            Extended timeout is an added timeout that is given once
 
212
            after a password has been sent successfully to a client.
 
213
            The timeout is by default longer than the normal timeout,
 
214
            and is used for handling the extra long downtime while a
 
215
            machine is booting up.  Time to take into consideration
 
216
            when changing this value is file system checks and quota
 
217
            checks.  The default value is 15 minutes.
 
218
          </para>
 
219
          <para>
 
220
            The format of <replaceable>TIME</replaceable> is the same
 
221
            as for <varname>timeout</varname> below.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
      
 
226
      <varlistentry>
 
227
        <term><option>fingerprint<literal> = </literal
 
228
        ><replaceable>HEXSTRING</replaceable></option></term>
 
229
        <listitem>
 
230
          <para>
 
231
            This option is <emphasis>required</emphasis> if the
 
232
            <option>key_id</option> is not set, and
 
233
            <emphasis>optional</emphasis> otherwise.
 
234
          </para>
 
235
          <para>
 
236
            This option sets the OpenPGP fingerprint that (before
 
237
            GnuTLS 3.6.0) identified the public key that clients
 
238
            authenticate themselves with through TLS.  The string
 
239
            needs to be in hexadecimal form, but spaces or upper/lower
 
240
            case are not significant.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      
 
245
      <varlistentry>
 
246
        <term><option>key_id<literal> = </literal
 
247
        ><replaceable>HEXSTRING</replaceable></option></term>
 
248
        <listitem>
 
249
          <para>
 
250
            This option is <emphasis>required</emphasis> if the
 
251
            <option>fingerprint</option> is not set, and
 
252
            <emphasis>optional</emphasis> otherwise.
 
253
          </para>
 
254
          <para>
 
255
            This option sets the certificate key ID that (with GnuTLS
 
256
            3.6.6 or later) identifies the public key that clients
 
257
            authenticate themselves with through TLS.  The string
 
258
            needs to be in hexadecimal form, but spaces or upper/lower
 
259
            case are not significant.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option><literal>host = </literal><replaceable
 
266
        >STRING</replaceable></option></term>
 
267
        <listitem>
 
268
          <para>
 
269
            This option is <emphasis>optional</emphasis>, but highly
 
270
            <emphasis>recommended</emphasis> unless the
 
271
            <option>checker</option> option is modified to a
 
272
            non-standard value without <quote>%%(host)s</quote> in it.
 
273
          </para>
 
274
          <para>
 
275
            Host name for this client.  This is not used by the server
 
276
            directly, but can be, and is by default, used by the
 
277
            checker.  See the <option>checker</option> option.
 
278
          </para>
 
279
        </listitem>
 
280
      </varlistentry>
 
281
      
 
282
      <varlistentry>
 
283
        <term><option>interval<literal> = </literal><replaceable
 
284
        >TIME</replaceable></option></term>
 
285
        <listitem>
 
286
          <para>
 
287
            This option is <emphasis>optional</emphasis>.
 
288
          </para>
153
289
          <para>
154
290
            How often to run the checker to confirm that a client is
155
291
            still up.  <emphasis>Note:</emphasis> a new checker will
156
292
            not be started if an old one is still running.  The server
157
 
            will wait for a checker to complete until the above
 
293
            will wait for a checker to complete until the below
158
294
            <quote><varname>timeout</varname></quote> occurs, at which
159
 
            time the client will be marked invalid, and any running
160
 
            checker killed.  The default interval is 5 minutes.
 
295
            time the client will be disabled, and any running checker
 
296
            killed.  The default interval is 2 minutes.
161
297
          </para>
162
298
          <para>
163
299
            The format of <replaceable>TIME</replaceable> is the same
164
 
            as for <varname>timeout</varname> above.
165
 
          </para>
166
 
        </listitem>
167
 
      </varlistentry>      
168
 
 
169
 
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
171
 
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
175
 
          <para>
176
 
            This option allows you to override the default shell
177
 
            command that the server will use to check if the client is
178
 
            still up.  The output of the command will be ignored, only
179
 
            the exit code is checked.  The command will be run using
180
 
            <quote><command><filename>/bin/sh</filename>
181
 
            <option>-c</option></command></quote>.  The default
182
 
            command is <quote><literal><command>fping</command>
183
 
            <option>-q</option> <option>--</option>
184
 
            %(host)s</literal></quote>.
185
 
          </para>
186
 
          <para>
187
 
            In addition to normal start time expansion, this option
188
 
            will also be subject to runtime expansion; see <xref
189
 
            linkend="expansion"/>.
190
 
          </para>
191
 
        </listitem>
192
 
      </varlistentry>
193
 
      
194
 
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
196
 
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
200
 
          <para>
201
 
            This option sets the OpenPGP fingerprint that identifies
202
 
            the public key that clients authenticate themselves with
203
 
            through TLS.  The string needs to be in hexidecimal form,
204
 
            but spaces or upper/lower case are not significant.
205
 
          </para>
206
 
        </listitem>
207
 
      </varlistentry>
208
 
      
209
 
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
211
 
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
300
            as for <varname>timeout</varname> below.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
 
306
        <term><option>secfile<literal> = </literal><replaceable
 
307
        >FILENAME</replaceable></option></term>
 
308
        <listitem>
 
309
          <para>
 
310
            This option is only used if <option>secret</option> is not
 
311
            specified, in which case this option is
 
312
            <emphasis>required</emphasis>.
 
313
          </para>
 
314
          <para>
 
315
            Similar to the <option>secret</option>, except the secret
 
316
            data is in an external file.  The contents of the file
 
317
            should <emphasis>not</emphasis> be base64-encoded, but
 
318
            will be sent to clients verbatim.
 
319
          </para>
 
320
          <para>
 
321
            File names of the form <filename>~user/foo/bar</filename>
 
322
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
323
            are supported.
 
324
          </para>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>secret<literal> = </literal><replaceable
 
330
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
331
        <listitem>
 
332
          <para>
 
333
            If this option is not specified, the <option
 
334
            >secfile</option> option is <emphasis>required</emphasis>
 
335
            to be present.
 
336
          </para>
215
337
          <para>
216
338
            If present, this option must be set to a string of
217
339
            base64-encoded binary data.  It will be decoded and sent
218
 
            to the client matching the above
219
 
            <option>fingerprint</option>.  This should, of course, be
220
 
            OpenPGP encrypted data, decryptable only by the client.
221
 
<!--        The program <citerefentry><refentrytitle><command -->
222
 
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
223
 
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
224
 
<!--        if desired. -->
225
 
          </para>
226
 
          <para>
227
 
            Note: this value of this option will probably run over
228
 
            many lines, and will then have to use the fact that a line
229
 
            beginning with white space adds to the value of the
230
 
            previous line, RFC 822-style.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>secfile</literal></term>
237
 
        <listitem>
238
 
          <para>
239
 
            Base 64 encoded OpenPGP encrypted password encrypted by
240
 
            the clients openpgp certificate as a binary file.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
      <varlistentry>
246
 
        <term><literal>host</literal></term>
247
 
        <listitem>
248
 
          <para>
249
 
            Host name that can be used in for checking that the client is up.
250
 
          </para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
 
254
 
      <varlistentry>
255
 
        <term><literal>checker</literal></term>
256
 
        <listitem>
257
 
          <para>
258
 
            Shell command that the server will use to check up if a
259
 
            client is still up.
260
 
          </para>
261
 
        </listitem>
262
 
      </varlistentry>      
263
 
 
264
 
      <varlistentry>
265
 
        <term><literal>timeout</literal></term>
266
 
        <listitem>
267
 
          <para>
268
 
            Duration that a client can be down whitout be removed from
269
 
            the client list.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry> 
 
340
            to the client matching the above <option>key_id</option>
 
341
            or <option>fingerprint</option>.  This should, of course,
 
342
            be OpenPGP encrypted data, decryptable only by the client.
 
343
            The program <citerefentry><refentrytitle><command
 
344
            >mandos-keygen</command></refentrytitle><manvolnum
 
345
            >8</manvolnum></citerefentry> can, using its
 
346
            <option>--password</option> option, be used to generate
 
347
            this, if desired.
 
348
          </para>
 
349
          <para>
 
350
            Note: this value of this option will probably be very
 
351
            long.  A useful feature to avoid having unreadably-long
 
352
            lines is that a line beginning with white space adds to
 
353
            the value of the previous line, RFC 822-style.
 
354
          </para>
 
355
        </listitem>
 
356
      </varlistentry>
 
357
      
 
358
      <varlistentry>
 
359
        <term><option>timeout<literal> = </literal><replaceable
 
360
        >TIME</replaceable></option></term>
 
361
        <listitem>
 
362
          <para>
 
363
            This option is <emphasis>optional</emphasis>.
 
364
          </para>
 
365
          <para>
 
366
            The timeout is how long the server will wait, after a
 
367
            successful checker run, until a client is disabled and not
 
368
            allowed to get the data this server holds.  By default
 
369
            Mandos will use 5 minutes.  See also the
 
370
            <option>extended_timeout</option> option.
 
371
          </para>
 
372
          <para>
 
373
            The <replaceable>TIME</replaceable> is specified as an RFC
 
374
            3339 duration; for example
 
375
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
376
            one year, two months, three days, four hours, five
 
377
            minutes, and six seconds.  Some values can be omitted, see
 
378
            RFC 3339 Appendix A for details.
 
379
          </para>
 
380
        </listitem>
 
381
      </varlistentry>
 
382
      
 
383
      <varlistentry>
 
384
        <term><option>enabled<literal> = </literal>{ <literal
 
385
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
386
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
387
        >no</literal> | <literal>false</literal> | <literal
 
388
        >off</literal> }</option></term>
 
389
        <listitem>
 
390
          <para>
 
391
            Whether this client should be enabled by default.  The
 
392
            default is <quote>true</quote>.
 
393
          </para>
 
394
        </listitem>
 
395
      </varlistentry>
273
396
      
274
397
    </variablelist>
275
 
  </refsect1>  
 
398
  </refsect1>
276
399
  
277
400
  <refsect1 id="expansion">
278
401
    <title>EXPANSION</title>
309
432
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
433
        ></quote> will be replaced by the value of the attribute
311
434
        <varname>foo</varname> of the internal
312
 
        <quote><classname>Client</classname></quote> object.  See the
313
 
        source code for details, and let the authors know of any
314
 
        attributes that are useful so they may be preserved to any new
315
 
        versions of this software.
 
435
        <quote><classname>Client</classname></quote> object in the
 
436
        Mandos server.  The currently allowed values for
 
437
        <replaceable>foo</replaceable> are:
 
438
        <quote><literal>approval_delay</literal></quote>,
 
439
        <quote><literal>approval_duration</literal></quote>,
 
440
        <quote><literal>created</literal></quote>,
 
441
        <quote><literal>enabled</literal></quote>,
 
442
        <quote><literal>expires</literal></quote>,
 
443
        <quote><literal>key_id</literal></quote>,
 
444
        <quote><literal>fingerprint</literal></quote>,
 
445
        <quote><literal>host</literal></quote>,
 
446
        <quote><literal>interval</literal></quote>,
 
447
        <quote><literal>last_approval_request</literal></quote>,
 
448
        <quote><literal>last_checked_ok</literal></quote>,
 
449
        <quote><literal>last_enabled</literal></quote>,
 
450
        <quote><literal>name</literal></quote>,
 
451
        <quote><literal>timeout</literal></quote>, and, if using
 
452
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
453
        See the source code for details.  <emphasis role="strong"
 
454
        >Currently, <emphasis>none</emphasis> of these attributes
 
455
        except <quote><literal>host</literal></quote> are guaranteed
 
456
        to be valid in future versions.</emphasis> Therefore, please
 
457
        let the authors know of any attributes that are useful so they
 
458
        may be preserved to any new versions of this software.
316
459
      </para>
317
460
      <para>
318
461
        Note that this means that, in order to include an actual
319
462
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
463
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
464
        percent characters in a row (<quote>%%%%</quote>) must be
322
465
        entered.  Also, a bad format here will lead to an immediate
323
466
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
467
        mode is needed to expose an error of this kind.
325
468
      </para>
326
469
    </refsect2>
327
 
 
328
 
  </refsect1>  
 
470
    
 
471
  </refsect1>
329
472
  
330
473
  <refsect1 id="files">
331
474
    <title>FILES</title>
346
489
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
347
490
      obscure.
348
491
    </para>
 
492
    <xi:include href="bugs.xml"/>
349
493
  </refsect1>
350
494
  
351
495
  <refsect1 id="example">
353
497
    <informalexample>
354
498
      <programlisting>
355
499
[DEFAULT]
356
 
timeout = 1h
357
 
interval = 5m
358
 
checker = fping -q -- %(host)s
 
500
timeout = PT5M
 
501
interval = PT2M
 
502
checker = fping -q -- %%(host)s
359
503
 
360
504
# Client "foo"
361
505
[foo]
 
506
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
362
507
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
363
508
secret =
364
509
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
376
521
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
522
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
523
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
524
host = foo.example.org
381
 
interval = 5m
 
525
interval = PT1M
382
526
 
383
527
# Client "bar"
384
528
[bar]
 
529
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
385
530
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
387
 
 
 
531
secfile = /etc/mandos/bar-secret
 
532
timeout = PT15M
 
533
approved_by_default = False
 
534
approval_delay = PT30S
388
535
      </programlisting>
389
536
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
537
  </refsect1>
 
538
  
 
539
  <refsect1 id="see_also">
 
540
    <title>SEE ALSO</title>
 
541
    <para>
 
542
      <citerefentry><refentrytitle>intro</refentrytitle>
 
543
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
544
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
545
      <manvolnum>8</manvolnum></citerefentry>,
 
546
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
547
      <manvolnum>5</manvolnum></citerefentry>,
 
548
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
549
      <manvolnum>8</manvolnum></citerefentry>,
 
550
      <citerefentry><refentrytitle>fping</refentrytitle>
 
551
      <manvolnum>8</manvolnum></citerefentry>
 
552
    </para>
 
553
    <variablelist>
 
554
      <varlistentry>
 
555
        <term>
 
556
          RFC 3339: <citetitle>Date and Time on the Internet:
 
557
          Timestamps</citetitle>
 
558
        </term>
 
559
      <listitem>
 
560
        <para>
 
561
          The time intervals are in the "duration" format, as
 
562
          specified in ABNF in Appendix A of RFC 3339.
 
563
        </para>
 
564
      </listitem>
 
565
      </varlistentry>
 
566
    </variablelist>
 
567
  </refsect1>
392
568
</refentry>
 
569
<!-- Local Variables: -->
 
570
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
571
<!-- time-stamp-end: "[\"']>" -->
 
572
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
573
<!-- End: -->