/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: 2012-06-01 21:48:12 UTC
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

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 "2010-09-26">
 
6
<!ENTITY TIMESTAMP "2012-05-27">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
64
66
      ><refentrytitle>mandos</refentrytitle>
65
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
68
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      even if a client was disabled in a previous run of the server.
 
69
      the service.  The settings in this file can be overridden by
 
70
      runtime changes to the server, which it saves across restarts.
 
71
      (See the section called <quote>PERSISTENT STATE</quote> in
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
73
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
74
      >changes</emphasis> to this file (including adding and removing
 
75
      clients) will, at startup, override changes done during runtime.
69
76
    </para>
70
77
    <para>
71
78
      The format starts with a <literal>[<replaceable>section
160
167
            This option is <emphasis>optional</emphasis>.
161
168
          </para>
162
169
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            run using <quote><command><filename>/bin/sh</filename>
 
170
            This option overrides the default shell command that the
 
171
            server will use to check if the client is still up.  Any
 
172
            output of the command will be ignored, only the exit code
 
173
            is checked:  If the exit code of the command is zero, the
 
174
            client is considered up.  The command will be run using
 
175
            <quote><command><filename>/bin/sh</filename>
169
176
            <option>-c</option></command></quote>, so
170
177
            <varname>PATH</varname> will be searched.  The default
171
178
            value for the checker command is <quote><literal
181
188
      </varlistentry>
182
189
      
183
190
      <varlistentry>
 
191
        <term><option>extended_timeout<literal> = </literal><replaceable
 
192
        >TIME</replaceable></option></term>
 
193
        <listitem>
 
194
          <para>
 
195
            This option is <emphasis>optional</emphasis>.
 
196
          </para>
 
197
          <para>
 
198
            Extended timeout is an added timeout that is given once
 
199
            after a password has been sent successfully to a client.
 
200
            The timeout is by default longer than the normal timeout,
 
201
            and is used for handling the extra long downtime while a
 
202
            machine is booting up.  Time to take into consideration
 
203
            when changing this value is file system checks and quota
 
204
            checks.  The default value is 15 minutes.
 
205
          </para>
 
206
          <para>
 
207
            The format of <replaceable>TIME</replaceable> is the same
 
208
            as for <varname>timeout</varname> below.
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
184
214
        <term><option>fingerprint<literal> = </literal
185
215
        ><replaceable>HEXSTRING</replaceable></option></term>
186
216
        <listitem>
228
258
            will wait for a checker to complete until the below
229
259
            <quote><varname>timeout</varname></quote> occurs, at which
230
260
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
261
            killed.  The default interval is 2 minutes.
232
262
          </para>
233
263
          <para>
234
264
            The format of <replaceable>TIME</replaceable> is the same
298
328
            This option is <emphasis>optional</emphasis>.
299
329
          </para>
300
330
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
 
331
            The timeout is how long the server will wait, after a
 
332
            successful checker run, until a client is disabled and not
 
333
            allowed to get the data this server holds.  By default
 
334
            Mandos will use 5 minutes.  See also the
 
335
            <option>extended_timeout</option> option.
305
336
          </para>
306
337
          <para>
307
338
            The <replaceable>TIME</replaceable> is specified as a
319
350
        </listitem>
320
351
      </varlistentry>
321
352
      
 
353
      <varlistentry>
 
354
        <term><option>enabled<literal> = </literal>{ <literal
 
355
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
356
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
357
        >no</literal> | <literal>false</literal> | <literal
 
358
        >off</literal> }</option></term>
 
359
        <listitem>
 
360
          <para>
 
361
            Whether this client should be enabled by default.  The
 
362
            default is <quote>true</quote>.
 
363
          </para>
 
364
        </listitem>
 
365
      </varlistentry>
 
366
      
322
367
    </variablelist>
323
368
  </refsect1>
324
369
  
364
409
        <quote><literal>approval_duration</literal></quote>,
365
410
        <quote><literal>created</literal></quote>,
366
411
        <quote><literal>enabled</literal></quote>,
 
412
        <quote><literal>expires</literal></quote>,
367
413
        <quote><literal>fingerprint</literal></quote>,
368
414
        <quote><literal>host</literal></quote>,
369
415
        <quote><literal>interval</literal></quote>,
419
465
    <informalexample>
420
466
      <programlisting>
421
467
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
468
timeout = 5m
 
469
interval = 2m
424
470
checker = fping -q -- %%(host)s
425
471
 
426
472
# Client "foo"
459
505
  <refsect1 id="see_also">
460
506
    <title>SEE ALSO</title>
461
507
    <para>
 
508
      <citerefentry><refentrytitle>intro</refentrytitle>
 
509
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
510
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
511
      <manvolnum>8</manvolnum></citerefentry>,
464
512
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
513
      <manvolnum>5</manvolnum></citerefentry>,
466
514
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
515
      <manvolnum>8</manvolnum></citerefentry>,
 
516
      <citerefentry><refentrytitle>fping</refentrytitle>
467
517
      <manvolnum>8</manvolnum></citerefentry>
468
518
    </para>
469
519
  </refsect1>