/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

  • Committer: Teddy Hogeborn
  • Date: 2008-07-31 19:51:44 UTC
  • mfrom: (24.1.5 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080731195144-yb37wz2sr1e6b3m4
Merge.

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