/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: Björn Påhlsson
  • Date: 2007-10-20 21:38:25 UTC
  • Revision ID: belorn@tower-20071020213825-abf6f0d1c33ee961
First working version with: IPv6, GnuTLS, X.509 certificates, DN
retrieval.

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