/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-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

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