/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: 2010-10-11 18:17:25 UTC
  • mfrom: (237.4.12 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20101011181725-ud266ctjhu3s730q
Merge from release branch.

Show diffs side-by-side

added added

removed removed

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