/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

* Makefile: Merge branch adding warning messages to "run-*" targets.

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
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-12">
 
6
<!ENTITY TIMESTAMP "2009-12-09">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
61
63
      ><refentrytitle>mandos</refentrytitle>
62
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
65
      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.
 
66
      the service.  All clients listed will be regarded as enabled,
 
67
      even if a client was disabled in a previous run of the server.
67
68
    </para>
68
69
    <para>
69
70
      The format starts with a <literal>[<replaceable>section
106
107
            This option is <emphasis>optional</emphasis>.
107
108
          </para>
108
109
          <para>
109
 
            The timeout is how long the server will wait for a
110
 
            successful checker run until a client is considered
111
 
            invalid - that is, ineligible to get the data this server
112
 
            holds.  By default Mandos will use 1 hour.
 
110
            The timeout is how long the server will wait (for either a
 
111
            successful checker run or a client receiving its secret)
 
112
            until a client is disabled and not allowed to get the data
 
113
            this server holds.  By default Mandos will use 1 hour.
113
114
          </para>
114
115
          <para>
115
116
            The <replaceable>TIME</replaceable> is specified as a
140
141
            not be started if an old one is still running.  The server
141
142
            will wait for a checker to complete until the above
142
143
            <quote><varname>timeout</varname></quote> occurs, at which
143
 
            time the client will be marked invalid, and any running
144
 
            checker killed.  The default interval is 5 minutes.
 
144
            time the client will be disabled, and any running checker
 
145
            killed.  The default interval is 5 minutes.
145
146
          </para>
146
147
          <para>
147
148
            The format of <replaceable>TIME</replaceable> is the same
168
169
            <varname>PATH</varname> will be searched.  The default
169
170
            value for the checker command is <quote><literal
170
171
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
172
            >--</option> %%(host)s</literal></quote>.
172
173
          </para>
173
174
          <para>
174
175
            In addition to normal start time expansion, this option
239
240
            should <emphasis>not</emphasis> be base64-encoded, but
240
241
            will be sent to clients verbatim.
241
242
          </para>
 
243
          <para>
 
244
            File names of the form <filename>~user/foo/bar</filename>
 
245
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
246
            are supported.
 
247
          </para>
242
248
        </listitem>
243
249
      </varlistentry>
244
250
      
250
256
            This option is <emphasis>optional</emphasis>, but highly
251
257
            <emphasis>recommended</emphasis> unless the
252
258
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
 
259
            non-standard value without <quote>%%(host)s</quote> in it.
254
260
          </para>
255
261
          <para>
256
262
            Host name for this client.  This is not used by the server
344
350
[DEFAULT]
345
351
timeout = 1h
346
352
interval = 5m
347
 
checker = fping -q -- %(host)s
 
353
checker = fping -q -- %%(host)s
348
354
 
349
355
# Client "foo"
350
356
[foo]