/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

* Makefile (LDFLAGS): Added "-Xlinker --as-needed".

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