/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-08-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
11
9
<refentry>
12
10
  <refentryinfo>
13
11
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>&CONFNAME;</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn</holder>
 
34
      <holder>Björn Påhlsson</holder>
36
35
    </copyright>
37
36
    <legalnotice>
38
37
      <para>
67
66
  <refnamediv>
68
67
    <refname><filename>&CONFNAME;</filename></refname>
69
68
    <refpurpose>
70
 
      Configuration file for Mandos clients
 
69
      Configuration file for the Mandos server
71
70
    </refpurpose>
72
71
  </refnamediv>
73
72
 
80
79
  <refsect1 id="description">
81
80
    <title>DESCRIPTION</title>
82
81
    <para>
83
 
      The file &CONFPATH; is the configuration file for mandos where
84
 
      each client that will be abel to use the service need to be
85
 
      specified. The configuration file is looked on at the startup of
86
 
      the service, so to reenable timedout clients one need to only
87
 
      restart the server. The format starts with a section under []
88
 
      which is eather <literal>[DEFAULT]</literal> or a client
89
 
      name. Values is set through the use of VAR = VALUE pair. Values
90
 
      may not be empty.
 
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.
91
108
    </para>
92
109
  </refsect1>
93
 
 
94
 
  <refsect1 id="default">
95
 
    <title>DEFAULTS</title>
96
 
    <para>
97
 
      The paramters for <literal>[DEFAULT]</literal> are:
 
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:
98
119
    </para>
99
120
 
100
121
    <variablelist>
101
 
      
 
122
 
102
123
      <varlistentry>
103
 
        <term><literal>timeout</literal></term>
 
124
        <term><literal><varname>timeout</varname></literal></term>
104
125
        <listitem>
105
 
          <para>
106
 
            This option allows you to override the default timeout
107
 
            that clients will get. By default mandos will use 1hr.
 
126
          <synopsis><literal>timeout = </literal><replaceable
 
127
          >TIME</replaceable>
 
128
          </synopsis>
 
129
          <para>
 
130
            The timeout is how long the server will wait for a
 
131
            successful checker run until a client is considered
 
132
            invalid - that is, ineligible to get the data this server
 
133
            holds.  By default Mandos will use 1 hour.
 
134
          </para>
 
135
          <para>
 
136
            The <replaceable>TIME</replaceable> is specified as a
 
137
            space-separated number of values, each of which is a
 
138
            number and a one-character suffix.  The suffix must be one
 
139
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
140
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
141
            minutes, hours, and weeks, respectively.  The values are
 
142
            added together to give the total time value, so all of
 
143
            <quote><literal>330s</literal></quote>,
 
144
            <quote><literal>110s 110s 110s</literal></quote>, and
 
145
            <quote><literal>5m 30s</literal></quote> will give a value
 
146
            of five minutes and thirty seconds.
108
147
          </para>
109
148
        </listitem>
110
149
      </varlistentry>
111
150
 
112
151
      <varlistentry>
113
 
        <term><literal>interval</literal></term>
 
152
        <term><literal><varname>interval</varname></literal></term>
114
153
        <listitem>
115
 
          <para>
116
 
            This option allows you to override the default interval
117
 
            used between checkups for disconnected clients. By default
118
 
            mandos will use 5m.
 
154
          <synopsis><literal>interval = </literal><replaceable
 
155
          >TIME</replaceable>
 
156
          </synopsis>
 
157
          <para>
 
158
            How often to run the checker to confirm that a client is
 
159
            still up.  <emphasis>Note:</emphasis> a new checker will
 
160
            not be started if an old one is still running.  The server
 
161
            will wait for a checker to complete until the above
 
162
            <quote><varname>timeout</varname></quote> occurs, at which
 
163
            time the client will be marked invalid, and any running
 
164
            checker killed.  The default interval is 5 minutes.
 
165
          </para>
 
166
          <para>
 
167
            The format of <replaceable>TIME</replaceable> is the same
 
168
            as for <varname>timeout</varname> above.
119
169
          </para>
120
170
        </listitem>
121
171
      </varlistentry>      
123
173
      <varlistentry>
124
174
        <term><literal>checker</literal></term>
125
175
        <listitem>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
126
179
          <para>
127
180
            This option allows you to override the default shell
128
 
            command that the server will use to check up if the client
129
 
            is still up. By default mandos will "fping -q -- %%(host)s"
 
181
            command that the server will use to check if the client is
 
182
            still up.  Any output of the command will be ignored, only
 
183
            the exit code is checked:  If the exit code of the command
 
184
            is zero, the client is considered up.  The command will be
 
185
            run using <quote><command><filename>/bin/sh</filename>
 
186
            <option>-c</option></command></quote>, so
 
187
            <varname>PATH</varname> will be searched.  The default
 
188
            value for the checker command is <quote><literal
 
189
            ><command>fping</command> <option>-q</option> <option
 
190
            >--</option> %(host)s</literal></quote>.
 
191
          </para>
 
192
          <para>
 
193
            In addition to normal start time expansion, this option
 
194
            will also be subject to runtime expansion; see <xref
 
195
            linkend="expansion"/>.
130
196
          </para>
131
197
        </listitem>
132
198
      </varlistentry>
133
199
      
134
 
    </variablelist>
135
 
  </refsect1>
136
 
 
137
 
  <refsect1 id="clients">
138
 
    <title>CLIENTS</title>
139
 
    <para>
140
 
      The paramters for clients are:
141
 
    </para>
142
 
 
143
 
    <variablelist>
144
 
      
145
200
      <varlistentry>
146
201
        <term><literal>fingerprint</literal></term>
147
202
        <listitem>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
148
206
          <para>
149
 
            This option sets the openpgp fingerprint that identifies
150
 
            the public certificate that clients authenticates themself
151
 
            through gnutls. The string need to be in hex-decimal form.
 
207
            This option sets the OpenPGP fingerprint that identifies
 
208
            the public key that clients authenticate themselves with
 
209
            through TLS.  The string needs to be in hexidecimal form,
 
210
            but spaces or upper/lower case are not significant.
152
211
          </para>
153
212
        </listitem>
154
213
      </varlistentry>
156
215
      <varlistentry>
157
216
        <term><literal>secret</literal></term>
158
217
        <listitem>
159
 
          <para>
160
 
            Base 64 encoded OpenPGP encrypted password encrypted by
161
 
            the clients openpgp certificate.
 
218
          <synopsis><literal>secret = </literal><replaceable
 
219
          >BASE64_ENCODED_DATA</replaceable>
 
220
          </synopsis>
 
221
          <para>
 
222
            If present, this option must be set to a string of
 
223
            base64-encoded binary data.  It will be decoded and sent
 
224
            to the client matching the above
 
225
            <option>fingerprint</option>.  This should, of course, be
 
226
            OpenPGP encrypted data, decryptable only by the client.
 
227
            The program <citerefentry><refentrytitle><command
 
228
            >mandos-keygen</command></refentrytitle><manvolnum
 
229
            >8</manvolnum></citerefentry> can, using its
 
230
            <option>--password</option> option, be used to generate
 
231
            this, if desired.
 
232
          </para>
 
233
          <para>
 
234
            Note: this value of this option will probably be very
 
235
            long.  A useful feature to avoid having unreadably-long
 
236
            lines is that a line beginning with white space adds to
 
237
            the value of the previous line, RFC 822-style.
 
238
          </para>
 
239
          <para>
 
240
            If this option is not specified, the <option
 
241
            >secfile</option> option is used instead, but one of them
 
242
            <emphasis>must</emphasis> be present.
162
243
          </para>
163
244
        </listitem>
164
245
      </varlistentry>
166
247
      <varlistentry>
167
248
        <term><literal>secfile</literal></term>
168
249
        <listitem>
169
 
          <para>
170
 
            Base 64 encoded OpenPGP encrypted password encrypted by
171
 
            the clients openpgp certificate as a binary file.
 
250
          <synopsis><literal>secfile = </literal><replaceable
 
251
          >FILENAME</replaceable>
 
252
          </synopsis>
 
253
          <para>
 
254
            The same as <option>secret</option>, but the secret data
 
255
            is in an external file.  The contents of the file should
 
256
            <emphasis>not</emphasis> be base64-encoded, but will be
 
257
            sent to clients verbatim.
 
258
          </para>
 
259
          <para>
 
260
            This option is only used, and <emphasis>must</emphasis> be
 
261
            present, if <option>secret</option> is not specified.
172
262
          </para>
173
263
        </listitem>
174
264
      </varlistentry>
176
266
      <varlistentry>
177
267
        <term><literal>host</literal></term>
178
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
179
272
          <para>
180
 
            Host name that can be used in for checking that the client is up.
 
273
            Host name for this client.  This is not used by the server
 
274
            directly, but can be, and is by default, used by the
 
275
            checker.  See the <option>checker</option> option.
181
276
          </para>
182
277
        </listitem>
183
278
      </varlistentry>
184
 
 
185
 
      <varlistentry>
186
 
        <term><literal>checker</literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            Shell command that the server will use to check up if a
190
 
            client is still up.
191
 
          </para>
192
 
        </listitem>
193
 
      </varlistentry>      
194
 
 
195
 
      <varlistentry>
196
 
        <term><literal>timeout</literal></term>
197
 
        <listitem>
198
 
          <para>
199
 
            Duration that a client can be down whitout be removed from
200
 
            the client list.
201
 
          </para>
202
 
        </listitem>
203
 
      </varlistentry> 
204
279
      
205
280
    </variablelist>
206
281
  </refsect1>  
 
282
  
 
283
  <refsect1 id="expansion">
 
284
    <title>EXPANSION</title>
 
285
    <para>
 
286
      There are two forms of expansion: Start time expansion and
 
287
      runtime expansion.
 
288
    </para>
 
289
    <refsect2 id="start_time_expansion">
 
290
      <title>START TIME EXPANSION</title>
 
291
      <para>
 
292
        Any string in an option value of the form
 
293
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
 
294
        ></quote> will be replaced by the value of the option
 
295
        <varname>foo</varname> either in the same section, or, if it
 
296
        does not exist there, the <literal>[DEFAULT]</literal>
 
297
        section.  This is done at start time, when the configuration
 
298
        file is read.
 
299
      </para>
 
300
      <para>
 
301
        Note that this means that, in order to include an actual
 
302
        percent character (<quote>%</quote>) in an option value, two
 
303
        percent characters in a row (<quote>%%</quote>) must be
 
304
        entered.
 
305
      </para>
 
306
    </refsect2>
 
307
    <refsect2 id="runtime_expansion">
 
308
      <title>RUNTIME EXPANSION</title>
 
309
      <para>
 
310
        This is currently only done for the <varname>checker</varname>
 
311
        option.
 
312
      </para>
 
313
      <para>
 
314
        Any string in an option value of the form
 
315
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
 
316
        ></quote> will be replaced by the value of the attribute
 
317
        <varname>foo</varname> of the internal
 
318
        <quote><classname>Client</classname></quote> object.  See the
 
319
        source code for details, and let the authors know of any
 
320
        attributes that are useful so they may be preserved to any new
 
321
        versions of this software.
 
322
      </para>
 
323
      <para>
 
324
        Note that this means that, in order to include an actual
 
325
        percent character (<quote>%</quote>) in a
 
326
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
327
        percent characters in a row (<quote>%%%%</quote>) must be
 
328
        entered.  Also, a bad format here will lead to an immediate
 
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
 
330
        mode is needed to track down an error of this kind.
 
331
      </para>
 
332
    </refsect2>
207
333
 
208
 
  <refsect1 id="examples">
209
 
    <title>EXAMPLES</title>
 
334
  </refsect1>  
 
335
  
 
336
  <refsect1 id="files">
 
337
    <title>FILES</title>
 
338
    <para>
 
339
      The file described here is &CONFPATH;
 
340
    </para>
 
341
  </refsect1>
 
342
  
 
343
  <refsect1 id="bugs">
 
344
    <title>BUGS</title>
 
345
    <para>
 
346
      The format for specifying times for <varname>timeout</varname>
 
347
      and <varname>interval</varname> is not very good.
 
348
    </para>
 
349
    <para>
 
350
      The difference between
 
351
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
 
352
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
 
353
      obscure.
 
354
    </para>
 
355
  </refsect1>
 
356
  
 
357
  <refsect1 id="example">
 
358
    <title>EXAMPLE</title>
210
359
    <informalexample>
211
360
      <programlisting>
212
361
[DEFAULT]
213
362
timeout = 1h
214
363
interval = 5m
215
 
checker = fping -q -- %%(host)s
 
364
checker = fping -q -- %(host)s
216
365
 
217
 
[example_client]
 
366
# Client "foo"
 
367
[foo]
218
368
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
219
 
 
220
369
secret =
221
370
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
222
371
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
233
382
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
234
383
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
235
384
        QlnHIvPzEArRQLo=
236
 
        =iHhv
237
 
 
238
 
host = localhost
239
 
interval = 5m
 
385
host = foo.example.org
 
386
interval = 1m
 
387
 
 
388
# Client "bar"
 
389
[bar]
 
390
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
 
391
secfile = /etc/mandos/bar-secret
 
392
timeout = 15m
 
393
 
240
394
      </programlisting>
241
395
    </informalexample>
242
396
  </refsect1>  
243
397
  
244
 
  <refsect1 id="files">
245
 
    <title>FILES</title>
 
398
  <refsect1 id="see_also">
 
399
    <title>SEE ALSO</title>
246
400
    <para>
247
 
      The file described here is &CONFPATH;
 
401
      <citerefentry>
 
402
        <refentrytitle>mandos</refentrytitle>
 
403
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
404
        <refentrytitle>mandos-keygen</refentrytitle>
 
405
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
406
        <refentrytitle>mandos.conf</refentrytitle>
 
407
        <manvolnum>5</manvolnum></citerefentry>
248
408
    </para>
249
409
  </refsect1>
250
410
</refentry>