/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-10-01 15:29:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001152901-fh30whl3m4vb7m24
* debian/changelog: New Debian revision.

* debian/mandos-client.lintian-overrides: Added comments.
* debian/mandos.lintian-overrides: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-12-09">
 
6
<!ENTITY TIMESTAMP "2008-09-30">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
 
      <year>2009</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
63
62
      ><refentrytitle>mandos</refentrytitle>
64
63
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
64
      The file needs to list all clients that should be able to use
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.
 
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
68
    </para>
69
69
    <para>
70
70
      The format starts with a <literal>[<replaceable>section
107
107
            This option is <emphasis>optional</emphasis>.
108
108
          </para>
109
109
          <para>
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.
 
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
114
          </para>
115
115
          <para>
116
116
            The <replaceable>TIME</replaceable> is specified as a
141
141
            not be started if an old one is still running.  The server
142
142
            will wait for a checker to complete until the above
143
143
            <quote><varname>timeout</varname></quote> occurs, at which
144
 
            time the client will be disabled, and any running checker
145
 
            killed.  The default interval is 5 minutes.
 
144
            time the client will be marked invalid, and any running
 
145
            checker killed.  The default interval is 5 minutes.
146
146
          </para>
147
147
          <para>
148
148
            The format of <replaceable>TIME</replaceable> is the same
169
169
            <varname>PATH</varname> will be searched.  The default
170
170
            value for the checker command is <quote><literal
171
171
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
172
            >--</option> %(host)s</literal></quote>.
173
173
          </para>
174
174
          <para>
175
175
            In addition to normal start time expansion, this option
240
240
            should <emphasis>not</emphasis> be base64-encoded, but
241
241
            will be sent to clients verbatim.
242
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>
248
243
        </listitem>
249
244
      </varlistentry>
250
245
      
256
251
            This option is <emphasis>optional</emphasis>, but highly
257
252
            <emphasis>recommended</emphasis> unless the
258
253
            <option>checker</option> option is modified to a
259
 
            non-standard value without <quote>%%(host)s</quote> in it.
 
254
            non-standard value without <quote>%(host)s</quote> in it.
260
255
          </para>
261
256
          <para>
262
257
            Host name for this client.  This is not used by the server
350
345
[DEFAULT]
351
346
timeout = 1h
352
347
interval = 5m
353
 
checker = fping -q -- %%(host)s
 
348
checker = fping -q -- %(host)s
354
349
 
355
350
# Client "foo"
356
351
[foo]