/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: 2008-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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 "2008-09-30">
 
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
      <holder>Teddy Hogeborn</holder>
 
37
      <holder>Björn Påhlsson</holder>
 
38
    </copyright>
 
39
    <xi:include href="legalnotice.xml"/>
 
40
  </refentryinfo>
 
41
  
 
42
  <refmeta>
 
43
    <refentrytitle>&CONFNAME;</refentrytitle>
 
44
    <manvolnum>5</manvolnum>
 
45
  </refmeta>
 
46
  
 
47
  <refnamediv>
 
48
    <refname><filename>&CONFNAME;</filename></refname>
 
49
    <refpurpose>
 
50
      Configuration file for the Mandos server
 
51
    </refpurpose>
 
52
  </refnamediv>
 
53
  
 
54
  <refsynopsisdiv>
 
55
    <synopsis>&CONFPATH;</synopsis>
 
56
  </refsynopsisdiv>
 
57
  
 
58
  <refsect1 id="description">
 
59
    <title>DESCRIPTION</title>
 
60
    <para>
 
61
      The file &CONFPATH; is a configuration file for <citerefentry
 
62
      ><refentrytitle>mandos</refentrytitle>
 
63
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
 
64
      The file needs to list all clients that should be able to use
 
65
      the service.  All clients listed will be regarded as valid, even
 
66
      if a client was declared invalid in a previous run of the
 
67
      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 a
 
111
            successful checker run until a client is considered
 
112
            invalid - that is, ineligible to get the data this server
 
113
            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 marked invalid, and any running
 
145
            checker 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
        </listitem>
 
244
      </varlistentry>
 
245
      
 
246
      <varlistentry>
 
247
        <term><option><literal>host = </literal><replaceable
 
248
        >STRING</replaceable></option></term>
 
249
        <listitem>
 
250
          <para>
 
251
            This option is <emphasis>optional</emphasis>, but highly
 
252
            <emphasis>recommended</emphasis> unless the
 
253
            <option>checker</option> option is modified to a
 
254
            non-standard value without <quote>%(host)s</quote> in it.
 
255
          </para>
 
256
          <para>
 
257
            Host name for this client.  This is not used by the server
 
258
            directly, but can be, and is by default, used by the
 
259
            checker.  See the <option>checker</option> option.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
    </variablelist>
 
265
  </refsect1>
 
266
  
 
267
  <refsect1 id="expansion">
 
268
    <title>EXPANSION</title>
 
269
    <para>
 
270
      There are two forms of expansion: Start time expansion and
 
271
      runtime expansion.
 
272
    </para>
 
273
    <refsect2 id="start_time_expansion">
 
274
      <title>START TIME EXPANSION</title>
 
275
      <para>
 
276
        Any string in an option value of the form
 
277
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
 
278
        ></quote> will be replaced by the value of the option
 
279
        <varname>foo</varname> either in the same section, or, if it
 
280
        does not exist there, the <literal>[DEFAULT]</literal>
 
281
        section.  This is done at start time, when the configuration
 
282
        file is read.
 
283
      </para>
 
284
      <para>
 
285
        Note that this means that, in order to include an actual
 
286
        percent character (<quote>%</quote>) in an option value, two
 
287
        percent characters in a row (<quote>%%</quote>) must be
 
288
        entered.
 
289
      </para>
 
290
    </refsect2>
 
291
    <refsect2 id="runtime_expansion">
 
292
      <title>RUNTIME EXPANSION</title>
 
293
      <para>
 
294
        This is currently only done for the <varname>checker</varname>
 
295
        option.
 
296
      </para>
 
297
      <para>
 
298
        Any string in an option value of the form
 
299
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
 
300
        ></quote> will be replaced by the value of the attribute
 
301
        <varname>foo</varname> of the internal
 
302
        <quote><classname>Client</classname></quote> object.  See the
 
303
        source code for details, and let the authors know of any
 
304
        attributes that are useful so they may be preserved to any new
 
305
        versions of this software.
 
306
      </para>
 
307
      <para>
 
308
        Note that this means that, in order to include an actual
 
309
        percent character (<quote>%</quote>) in a
 
310
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
311
        percent characters in a row (<quote>%%%%</quote>) must be
 
312
        entered.  Also, a bad format here will lead to an immediate
 
313
        but <emphasis>silent</emphasis> run-time fatal exit; debug
 
314
        mode is needed to expose an error of this kind.
 
315
      </para>
 
316
    </refsect2>
 
317
    
 
318
  </refsect1>
 
319
  
 
320
  <refsect1 id="files">
 
321
    <title>FILES</title>
 
322
    <para>
 
323
      The file described here is &CONFPATH;
 
324
    </para>
 
325
  </refsect1>
 
326
  
 
327
  <refsect1 id="bugs">
 
328
    <title>BUGS</title>
 
329
    <para>
 
330
      The format for specifying times for <varname>timeout</varname>
 
331
      and <varname>interval</varname> is not very good.
 
332
    </para>
 
333
    <para>
 
334
      The difference between
 
335
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
 
336
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
 
337
      obscure.
 
338
    </para>
 
339
  </refsect1>
 
340
  
 
341
  <refsect1 id="example">
 
342
    <title>EXAMPLE</title>
 
343
    <informalexample>
 
344
      <programlisting>
 
345
[DEFAULT]
 
346
timeout = 1h
 
347
interval = 5m
 
348
checker = fping -q -- %(host)s
 
349
 
 
350
# Client "foo"
 
351
[foo]
 
352
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
 
353
secret =
 
354
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
 
355
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
 
356
        Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
 
357
        3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
 
358
        Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
 
359
        QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
 
360
        t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
 
361
        3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
 
362
        dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
 
363
        WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
 
364
        zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
 
365
        vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
 
366
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
 
367
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
 
368
        QlnHIvPzEArRQLo=
 
369
host = foo.example.org
 
370
interval = 1m
 
371
 
 
372
# Client "bar"
 
373
[bar]
 
374
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
 
375
secfile = /etc/mandos/bar-secret
 
376
timeout = 15m
 
377
      </programlisting>
 
378
    </informalexample>
 
379
  </refsect1>
 
380
  
 
381
  <refsect1 id="see_also">
 
382
    <title>SEE ALSO</title>
 
383
    <para>
 
384
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
385
      <manvolnum>8</manvolnum></citerefentry>,
 
386
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
387
      <manvolnum>5</manvolnum></citerefentry>,
 
388
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
389
      <manvolnum>8</manvolnum></citerefentry>
 
390
    </para>
 
391
  </refsect1>
 
392
</refentry>
 
393
<!-- Local Variables: -->
 
394
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
395
<!-- time-stamp-end: "[\"']>" -->
 
396
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
397
<!-- End: -->