/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-27 01:18:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080827011825-ka3ni6xvy2ehi1y8
* .bzrignore: New.

* clients.conf ([foo]): Remove Radix-64 checksum.

* mandos (AvahiService.rename, server_state_changed,
          entry_group_state_changed): Make Avahi log messages more
                                      clear that they are about
                                      Zeroconf.
  (fingerprint): Use plain "0" instead of "ctypes.c_uint(0)".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
79
79
  <refsect1 id="description">
80
80
    <title>DESCRIPTION</title>
81
81
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
82
      The file &CONFPATH; is a configuration file for <citerefentry
83
83
      ><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
 
      where each client that will be able to use the service needs to
86
 
      be listed.  All clients listed will be regarded as valid, even
 
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
87
      if a client was declared invalid in a previous run of the
88
88
      server.
89
89
    </para>
90
90
    <para>
91
 
      The format starts with a section under [] which is either
 
91
      The format starts with a <literal>[<replaceable>section
 
92
      header</replaceable>]</literal> which is either
92
93
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
93
 
      name</replaceable>]</literal>.  Following the section is any
94
 
      number of <quote><varname><replaceable>option</replaceable
 
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
95
98
      ></varname>=<replaceable>value</replaceable></quote> entries,
96
99
      with continuations in the style of RFC 822.  <quote><varname
97
100
      ><replaceable>option</replaceable></varname>: <replaceable
98
101
      >value</replaceable></quote> is also accepted.  Note that
99
102
      leading whitespace is removed from values.  Values can contain
100
103
      format strings which refer to other values in the same section,
101
 
      or values in the <quote>DEFAULT</quote> section.  Lines
102
 
      beginning with <quote>#</quote> or <quote>;</quote> are ignored
103
 
      and may be used to provide comments.
 
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.
104
108
    </para>
105
109
  </refsect1>
106
110
  
107
111
  <refsect1 id="options">
108
112
    <title>OPTIONS</title>
109
113
    <para>
110
 
      The possible options are:
 
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:
111
119
    </para>
112
120
 
113
121
    <variablelist>
165
173
      <varlistentry>
166
174
        <term><literal>checker</literal></term>
167
175
        <listitem>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
168
179
          <para>
169
180
            This option allows you to override the default shell
170
 
            command that the server will use to check up if the client
171
 
            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"/>.
172
196
          </para>
173
197
        </listitem>
174
198
      </varlistentry>
176
200
      <varlistentry>
177
201
        <term><literal>fingerprint</literal></term>
178
202
        <listitem>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
179
206
          <para>
180
 
            This option sets the openpgp fingerprint that identifies
181
 
            the public certificate that clients authenticates themself
182
 
            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.
183
211
          </para>
184
212
        </listitem>
185
213
      </varlistentry>
187
215
      <varlistentry>
188
216
        <term><literal>secret</literal></term>
189
217
        <listitem>
190
 
          <para>
191
 
            Base 64 encoded OpenPGP encrypted password encrypted by
192
 
            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.
193
243
          </para>
194
244
        </listitem>
195
245
      </varlistentry>
197
247
      <varlistentry>
198
248
        <term><literal>secfile</literal></term>
199
249
        <listitem>
200
 
          <para>
201
 
            Base 64 encoded OpenPGP encrypted password encrypted by
202
 
            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.
203
262
          </para>
204
263
        </listitem>
205
264
      </varlistentry>
207
266
      <varlistentry>
208
267
        <term><literal>host</literal></term>
209
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
210
272
          <para>
211
 
            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.
212
276
          </para>
213
277
        </listitem>
214
278
      </varlistentry>
215
 
 
216
 
      <varlistentry>
217
 
        <term><literal>checker</literal></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Shell command that the server will use to check up if a
221
 
            client is still up.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>      
225
 
 
226
 
      <varlistentry>
227
 
        <term><literal>timeout</literal></term>
228
 
        <listitem>
229
 
          <para>
230
 
            Duration that a client can be down whitout be removed from
231
 
            the client list.
232
 
          </para>
233
 
        </listitem>
234
 
      </varlistentry> 
235
279
      
236
280
    </variablelist>
237
281
  </refsect1>  
242
286
      There are two forms of expansion: Start time expansion and
243
287
      runtime expansion.
244
288
    </para>
245
 
    <refsect2>
 
289
    <refsect2 id="start_time_expansion">
246
290
      <title>START TIME EXPANSION</title>
247
291
      <para>
248
292
        Any string in an option value of the form
260
304
        entered.
261
305
      </para>
262
306
    </refsect2>
263
 
    <refsect2>
 
307
    <refsect2 id="runtime_expansion">
264
308
      <title>RUNTIME EXPANSION</title>
265
309
      <para>
266
310
        This is currently only done for the <varname>checker</varname>
279
323
      <para>
280
324
        Note that this means that, in order to include an actual
281
325
        percent character (<quote>%</quote>) in a
282
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
326
        <varname>checker</varname> option, <emphasis>four</emphasis>
283
327
        percent characters in a row (<quote>%%%%</quote>) must be
284
328
        entered.  Also, a bad format here will lead to an immediate
285
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
317
361
[DEFAULT]
318
362
timeout = 1h
319
363
interval = 5m
320
 
checker = fping -q -- %%(host)s
 
364
checker = fping -q -- %(host)s
321
365
 
322
366
# Client "foo"
323
367
[foo]
338
382
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
339
383
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
340
384
        QlnHIvPzEArRQLo=
341
 
        =iHhv
342
385
host = foo.example.org
343
 
interval = 5m
 
386
interval = 1m
344
387
 
345
388
# Client "bar"
346
389
[bar]
347
390
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
348
 
secfile = /etc/mandos/bar-secret.txt.asc
 
391
secfile = /etc/mandos/bar-secret
 
392
timeout = 15m
349
393
 
350
394
      </programlisting>
351
395
    </informalexample>
352
396
  </refsect1>  
353
 
 
 
397
  
 
398
  <refsect1 id="see_also">
 
399
    <title>SEE ALSO</title>
 
400
    <para>
 
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>
 
408
    </para>
 
409
  </refsect1>
354
410
</refentry>