/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

Merge from release branch.

Show diffs side-by-side

added added

removed removed

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