/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

Added more stuff to do

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
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY CONFNAME "mandos-clients.conf">
5
8
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2019-02-10">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
9
]>
10
10
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
12
12
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <title>&CONFNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&CONFNAME;</productname>
 
16
    <productnumber>&VERSION;</productnumber>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <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>
47
 
      <holder>Teddy Hogeborn</holder>
48
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
49
36
    </copyright>
50
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
51
60
  </refentryinfo>
52
 
  
 
61
 
53
62
  <refmeta>
54
63
    <refentrytitle>&CONFNAME;</refentrytitle>
55
64
    <manvolnum>5</manvolnum>
58
67
  <refnamediv>
59
68
    <refname><filename>&CONFNAME;</filename></refname>
60
69
    <refpurpose>
61
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos clients
62
71
    </refpurpose>
63
72
  </refnamediv>
64
 
  
 
73
 
65
74
  <refsynopsisdiv>
66
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
67
78
  </refsynopsisdiv>
68
 
  
 
79
 
69
80
  <refsect1 id="description">
70
81
    <title>DESCRIPTION</title>
71
82
    <para>
72
 
      The file &CONFPATH; is a configuration file for <citerefentry
73
 
      ><refentrytitle>mandos</refentrytitle>
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.
83
 
    </para>
84
 
    <para>
85
 
      The format starts with a <literal>[<replaceable>section
86
 
      header</replaceable>]</literal> which is either
87
 
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
88
 
      name</replaceable>]</literal>.  The <replaceable>client
89
 
      name</replaceable> can be anything, and is not tied to a host
90
 
      name.  Following the section header is any number of
91
 
      <quote><varname><replaceable>option</replaceable
92
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
93
 
      with continuations in the style of RFC 822.  <quote><varname
94
 
      ><replaceable>option</replaceable></varname>: <replaceable
95
 
      >value</replaceable></quote> is also accepted.  Note that
96
 
      leading whitespace is removed from values.  Values can contain
97
 
      format strings which refer to other values in the same section,
98
 
      or values in the <quote>DEFAULT</quote> section (see <xref
99
 
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
100
 
      or <quote>;</quote> are ignored and may be used to provide
101
 
      comments.
102
 
    </para>
103
 
  </refsect1>
104
 
  
105
 
  <refsect1 id="options">
106
 
    <title>OPTIONS</title>
107
 
    <para>
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
 
    
115
 
    <variablelist>
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>.
232
 
          </para>
233
 
          <para>
234
 
            This option sets the OpenPGP fingerprint that identifies
235
 
            the public key that clients authenticate themselves with
236
 
            through TLS.  The string needs to be in hexadecimal form,
237
 
            but spaces or upper/lower case are not significant.
238
 
          </para>
239
 
        </listitem>
240
 
      </varlistentry>
241
 
      
242
 
      <varlistentry>
243
 
        <term><option>key_id<literal> = </literal
244
 
        ><replaceable>HEXSTRING</replaceable></option></term>
245
 
        <listitem>
246
 
          <para>
247
 
            This option is <emphasis>optional</emphasis>.
248
 
          </para>
249
 
          <para>
250
 
            This option sets the certificate key ID that identifies
251
 
            the public key that clients authenticate themselves with
252
 
            through TLS.  The string needs to be in hexadecimal form,
253
 
            but spaces or upper/lower case are not significant.
254
 
          </para>
255
 
        </listitem>
256
 
      </varlistentry>
257
 
      
258
 
      <varlistentry>
259
 
        <term><option><literal>host = </literal><replaceable
260
 
        >STRING</replaceable></option></term>
261
 
        <listitem>
262
 
          <para>
263
 
            This option is <emphasis>optional</emphasis>, but highly
264
 
            <emphasis>recommended</emphasis> unless the
265
 
            <option>checker</option> option is modified to a
266
 
            non-standard value without <quote>%%(host)s</quote> in it.
267
 
          </para>
268
 
          <para>
269
 
            Host name for this client.  This is not used by the server
270
 
            directly, but can be, and is by default, used by the
271
 
            checker.  See the <option>checker</option> option.
272
 
          </para>
273
 
        </listitem>
274
 
      </varlistentry>
275
 
      
276
 
      <varlistentry>
277
 
        <term><option>interval<literal> = </literal><replaceable
278
 
        >TIME</replaceable></option></term>
279
 
        <listitem>
280
 
          <para>
281
 
            This option is <emphasis>optional</emphasis>.
282
 
          </para>
283
 
          <para>
284
 
            How often to run the checker to confirm that a client is
285
 
            still up.  <emphasis>Note:</emphasis> a new checker will
286
 
            not be started if an old one is still running.  The server
287
 
            will wait for a checker to complete until the below
288
 
            <quote><varname>timeout</varname></quote> occurs, at which
289
 
            time the client will be disabled, and any running checker
290
 
            killed.  The default interval is 2 minutes.
291
 
          </para>
292
 
          <para>
293
 
            The format of <replaceable>TIME</replaceable> is the same
294
 
            as for <varname>timeout</varname> below.
295
 
          </para>
296
 
        </listitem>
297
 
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>secfile<literal> = </literal><replaceable
301
 
        >FILENAME</replaceable></option></term>
302
 
        <listitem>
303
 
          <para>
304
 
            This option is only used if <option>secret</option> is not
305
 
            specified, in which case this option is
306
 
            <emphasis>required</emphasis>.
307
 
          </para>
308
 
          <para>
309
 
            Similar to the <option>secret</option>, except the secret
310
 
            data is in an external file.  The contents of the file
311
 
            should <emphasis>not</emphasis> be base64-encoded, but
312
 
            will be sent to clients verbatim.
313
 
          </para>
314
 
          <para>
315
 
            File names of the form <filename>~user/foo/bar</filename>
316
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
317
 
            are supported.
318
 
          </para>
319
 
        </listitem>
320
 
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>secret<literal> = </literal><replaceable
324
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
325
 
        <listitem>
326
 
          <para>
327
 
            If this option is not specified, the <option
328
 
            >secfile</option> option is <emphasis>required</emphasis>
329
 
            to be present.
330
 
          </para>
331
 
          <para>
332
 
            If present, this option must be set to a string of
333
 
            base64-encoded binary data.  It will be decoded and sent
334
 
            to the client matching the above <option>key_id</option>
335
 
            or <option>fingerprint</option>.  This should, of course,
336
 
            be OpenPGP encrypted data, decryptable only by the client.
337
 
            The program <citerefentry><refentrytitle><command
338
 
            >mandos-keygen</command></refentrytitle><manvolnum
339
 
            >8</manvolnum></citerefentry> can, using its
340
 
            <option>--password</option> option, be used to generate
341
 
            this, if desired.
342
 
          </para>
343
 
          <para>
344
 
            Note: this value of this option will probably be very
345
 
            long.  A useful feature to avoid having unreadably-long
346
 
            lines is that a line beginning with white space adds to
347
 
            the value of the previous line, RFC 822-style.
348
 
          </para>
349
 
        </listitem>
350
 
      </varlistentry>
351
 
      
352
 
      <varlistentry>
353
 
        <term><option>timeout<literal> = </literal><replaceable
354
 
        >TIME</replaceable></option></term>
355
 
        <listitem>
356
 
          <para>
357
 
            This option is <emphasis>optional</emphasis>.
358
 
          </para>
359
 
          <para>
360
 
            The timeout is how long the server will wait, after a
361
 
            successful checker run, until a client is disabled and not
362
 
            allowed to get the data this server holds.  By default
363
 
            Mandos will use 5 minutes.  See also the
364
 
            <option>extended_timeout</option> option.
365
 
          </para>
366
 
          <para>
367
 
            The <replaceable>TIME</replaceable> is specified as an RFC
368
 
            3339 duration; for example
369
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
370
 
            one year, two months, three days, four hours, five
371
 
            minutes, and six seconds.  Some values can be omitted, see
372
 
            RFC 3339 Appendix A for details.
373
 
          </para>
374
 
        </listitem>
375
 
      </varlistentry>
376
 
      
377
 
      <varlistentry>
378
 
        <term><option>enabled<literal> = </literal>{ <literal
379
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
380
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
381
 
        >no</literal> | <literal>false</literal> | <literal
382
 
        >off</literal> }</option></term>
383
 
        <listitem>
384
 
          <para>
385
 
            Whether this client should be enabled by default.  The
386
 
            default is <quote>true</quote>.
387
 
          </para>
388
 
        </listitem>
389
 
      </varlistentry>
390
 
      
391
 
    </variablelist>
392
 
  </refsect1>
393
 
  
394
 
  <refsect1 id="expansion">
395
 
    <title>EXPANSION</title>
396
 
    <para>
397
 
      There are two forms of expansion: Start time expansion and
398
 
      runtime expansion.
399
 
    </para>
400
 
    <refsect2 id="start_time_expansion">
401
 
      <title>START TIME EXPANSION</title>
402
 
      <para>
403
 
        Any string in an option value of the form
404
 
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
405
 
        ></quote> will be replaced by the value of the option
406
 
        <varname>foo</varname> either in the same section, or, if it
407
 
        does not exist there, the <literal>[DEFAULT]</literal>
408
 
        section.  This is done at start time, when the configuration
409
 
        file is read.
410
 
      </para>
411
 
      <para>
412
 
        Note that this means that, in order to include an actual
413
 
        percent character (<quote>%</quote>) in an option value, two
414
 
        percent characters in a row (<quote>%%</quote>) must be
415
 
        entered.
416
 
      </para>
417
 
    </refsect2>
418
 
    <refsect2 id="runtime_expansion">
419
 
      <title>RUNTIME EXPANSION</title>
420
 
      <para>
421
 
        This is currently only done for the <varname>checker</varname>
422
 
        option.
423
 
      </para>
424
 
      <para>
425
 
        Any string in an option value of the form
426
 
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
427
 
        ></quote> will be replaced by the value of the attribute
428
 
        <varname>foo</varname> of the internal
429
 
        <quote><classname>Client</classname></quote> object in the
430
 
        Mandos server.  The currently allowed values for
431
 
        <replaceable>foo</replaceable> are:
432
 
        <quote><literal>approval_delay</literal></quote>,
433
 
        <quote><literal>approval_duration</literal></quote>,
434
 
        <quote><literal>created</literal></quote>,
435
 
        <quote><literal>enabled</literal></quote>,
436
 
        <quote><literal>expires</literal></quote>,
437
 
        <quote><literal>key_id</literal></quote>,
438
 
        <quote><literal>fingerprint</literal></quote>,
439
 
        <quote><literal>host</literal></quote>,
440
 
        <quote><literal>interval</literal></quote>,
441
 
        <quote><literal>last_approval_request</literal></quote>,
442
 
        <quote><literal>last_checked_ok</literal></quote>,
443
 
        <quote><literal>last_enabled</literal></quote>,
444
 
        <quote><literal>name</literal></quote>,
445
 
        <quote><literal>timeout</literal></quote>, and, if using
446
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
447
 
        See the source code for details.  <emphasis role="strong"
448
 
        >Currently, <emphasis>none</emphasis> of these attributes
449
 
        except <quote><literal>host</literal></quote> are guaranteed
450
 
        to be valid in future versions.</emphasis> Therefore, please
451
 
        let the authors know of any attributes that are useful so they
452
 
        may be preserved to any new versions of this software.
453
 
      </para>
454
 
      <para>
455
 
        Note that this means that, in order to include an actual
456
 
        percent character (<quote>%</quote>) in a
457
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
458
 
        percent characters in a row (<quote>%%%%</quote>) must be
459
 
        entered.  Also, a bad format here will lead to an immediate
460
 
        but <emphasis>silent</emphasis> run-time fatal exit; debug
461
 
        mode is needed to expose an error of this kind.
462
 
      </para>
463
 
    </refsect2>
464
 
    
465
 
  </refsect1>
466
 
  
467
 
  <refsect1 id="files">
468
 
    <title>FILES</title>
469
 
    <para>
470
 
      The file described here is &CONFPATH;
471
 
    </para>
472
 
  </refsect1>
473
 
  
474
 
  <refsect1 id="bugs">
475
 
    <title>BUGS</title>
476
 
    <para>
477
 
      The format for specifying times for <varname>timeout</varname>
478
 
      and <varname>interval</varname> is not very good.
479
 
    </para>
480
 
    <para>
481
 
      The difference between
482
 
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
483
 
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
484
 
      obscure.
485
 
    </para>
486
 
    <xi:include href="bugs.xml"/>
487
 
  </refsect1>
488
 
  
489
 
  <refsect1 id="example">
490
 
    <title>EXAMPLE</title>
 
83
      The file &CONFPATH; is the configuration file for mandos where
 
84
      each client that will be abel to use the service need to be
 
85
      specified. The configuration file is looked on at the startup of
 
86
      the service, so to reenable timedout clients one need to only
 
87
      restart the server. The format starts with a section under []
 
88
      which is eather <literal>[DEFAULT]</literal> or a client
 
89
      name. Values is set through the use of VAR = VALUE pair. Values
 
90
      may not be empty.
 
91
    </para>
 
92
  </refsect1>
 
93
 
 
94
  <refsect1 id="default">
 
95
    <title>DEFAULTS</title>
 
96
    <para>
 
97
      The paramters for <literal>[DEFAULT]</literal> are:
 
98
    </para>
 
99
 
 
100
    <variablelist>
 
101
      
 
102
      <varlistentry>
 
103
        <term><literal>timeout</literal></term>
 
104
        <listitem>
 
105
          <para>
 
106
            This option allows you to override the default timeout
 
107
            that clients will get. By default mandos will use 1hr.
 
108
          </para>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
 
 
112
      <varlistentry>
 
113
        <term><literal>interval</literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            This option allows you to override the default interval
 
117
            used between checkups for disconnected clients. By default
 
118
            mandos will use 5m.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>      
 
122
 
 
123
      <varlistentry>
 
124
        <term><literal>checker</literal></term>
 
125
        <listitem>
 
126
          <para>
 
127
            This option allows you to override the default shell
 
128
            command that the server will use to check up if the client
 
129
            is still up. By default mandos will "fping -q -- %%(host)s"
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
    </variablelist>
 
135
  </refsect1>
 
136
 
 
137
  <refsect1 id="clients">
 
138
    <title>CLIENTS</title>
 
139
    <para>
 
140
      The paramters for clients are:
 
141
    </para>
 
142
 
 
143
    <variablelist>
 
144
      
 
145
      <varlistentry>
 
146
        <term><literal>fingerprint</literal></term>
 
147
        <listitem>
 
148
          <para>
 
149
            This option sets the openpgp fingerprint that identifies
 
150
            the public certificate that clients authenticates themself
 
151
            through gnutls. The string need to be in hex-decimal form.
 
152
          </para>
 
153
        </listitem>
 
154
      </varlistentry>
 
155
      
 
156
      <varlistentry>
 
157
        <term><literal>secret</literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Base 64 encoded OpenPGP encrypted password encrypted by
 
161
            the clients openpgp certificate.
 
162
          </para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
 
 
166
      <varlistentry>
 
167
        <term><literal>secfile</literal></term>
 
168
        <listitem>
 
169
          <para>
 
170
            Base 64 encoded OpenPGP encrypted password encrypted by
 
171
            the clients openpgp certificate as a binary file.
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
 
 
176
      <varlistentry>
 
177
        <term><literal>host</literal></term>
 
178
        <listitem>
 
179
          <para>
 
180
            Host name that can be used in for checking that the client is up.
 
181
          </para>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
 
 
185
      <varlistentry>
 
186
        <term><literal>checker</literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            Shell command that the server will use to check up if a
 
190
            client is still up.
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>      
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>timeout</literal></term>
 
197
        <listitem>
 
198
          <para>
 
199
            Duration that a client can be down whitout be removed from
 
200
            the client list.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry> 
 
204
      
 
205
    </variablelist>
 
206
  </refsect1>  
 
207
 
 
208
  <refsect1 id="examples">
 
209
    <title>EXAMPLES</title>
491
210
    <informalexample>
492
211
      <programlisting>
493
212
[DEFAULT]
494
 
timeout = PT5M
495
 
interval = PT2M
 
213
timeout = 1h
 
214
interval = 5m
496
215
checker = fping -q -- %%(host)s
497
216
 
498
 
# Client "foo"
499
 
[foo]
500
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
 
217
[example_client]
501
218
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
 
219
 
502
220
secret =
503
221
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
504
222
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
515
233
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
516
234
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
517
235
        QlnHIvPzEArRQLo=
518
 
host = foo.example.org
519
 
interval = PT1M
 
236
        =iHhv
520
237
 
521
 
# Client "bar"
522
 
[bar]
523
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
524
 
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
525
 
secfile = /etc/mandos/bar-secret
526
 
timeout = PT15M
527
 
approved_by_default = False
528
 
approval_delay = PT30S
 
238
host = localhost
 
239
interval = 5m
529
240
      </programlisting>
530
241
    </informalexample>
531
 
  </refsect1>
 
242
  </refsect1>  
532
243
  
533
 
  <refsect1 id="see_also">
534
 
    <title>SEE ALSO</title>
 
244
  <refsect1 id="files">
 
245
    <title>FILES</title>
535
246
    <para>
536
 
      <citerefentry><refentrytitle>intro</refentrytitle>
537
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
538
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
539
 
      <manvolnum>8</manvolnum></citerefentry>,
540
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
541
 
      <manvolnum>5</manvolnum></citerefentry>,
542
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
543
 
      <manvolnum>8</manvolnum></citerefentry>,
544
 
      <citerefentry><refentrytitle>fping</refentrytitle>
545
 
      <manvolnum>8</manvolnum></citerefentry>
 
247
      The file described here is &CONFPATH;
546
248
    </para>
547
 
    <variablelist>
548
 
      <varlistentry>
549
 
        <term>
550
 
          RFC 3339: <citetitle>Date and Time on the Internet:
551
 
          Timestamps</citetitle>
552
 
        </term>
553
 
      <listitem>
554
 
        <para>
555
 
          The time intervals are in the "duration" format, as
556
 
          specified in ABNF in Appendix A of RFC 3339.
557
 
        </para>
558
 
      </listitem>
559
 
      </varlistentry>
560
 
    </variablelist>
561
249
  </refsect1>
562
250
</refentry>
563
 
<!-- Local Variables: -->
564
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
565
 
<!-- time-stamp-end: "[\"']>" -->
566
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
567
 
<!-- End: -->