/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: 2008-08-14 02:24:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080814022459-rq3jt4q409l3qbj3
* Makefile (PREFIX, CONFDIR): New.

* initramfs-tools-hook: Search for Mandos in /usr/local as well as in
                        /usr.  Also copy plugin-runner.  Also chmod
                        the config dir.
  (DESTCONFDIR): Removed.
  (MANDOSDIR): New.
  (PLUGINDIR): Changed to "${MANDOSDIR}/plugins.d".

* initramfs-tools-script: New.

* mandos-client.c: Renamed to "plugin-runner.c".  All references
                   changed.
  (plugindir): Changed to "/lib/mandos/plugins.d".

* plugins.d/usplash: New.

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