/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 at recompile
  • Date: 2011-12-31 13:25:58 UTC
  • mto: (237.7.89 trunk)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@recompile.se-20111231132558-z0dh7qgofgctmgri
* network-hooks.s/bridge: Don't use interface names directly; search
                          for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/bridge.conf (PORTS): Removed.
  (PORT_ADDRESSES): New.
* network-hooks.s/wireless: Don't use interface names directly; search
                            for interface names using their address.
  (addrtoif): New function.
* network-hooks.s/wireless.conf: Specify address.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2011-11-26">
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>
38
39
      <holder>Teddy Hogeborn</holder>
39
40
      <holder>Björn Påhlsson</holder>
40
41
    </copyright>
181
182
      </varlistentry>
182
183
      
183
184
      <varlistentry>
 
185
        <term><option>extended_timeout<literal> = </literal><replaceable
 
186
        >TIME</replaceable></option></term>
 
187
        <listitem>
 
188
          <para>
 
189
            This option is <emphasis>optional</emphasis>.
 
190
          </para>
 
191
          <para>
 
192
            Extended timeout is an added timeout that is given once
 
193
            after a password has been sent successfully to a client.
 
194
            The timeout is by default longer than the normal timeout,
 
195
            and is used for handling the extra long downtime while a
 
196
            machine is booting up.  Time to take into consideration
 
197
            when changing this value is file system checks and quota
 
198
            checks.  The default value is 15 minutes.
 
199
          </para>
 
200
          <para>
 
201
            The format of <replaceable>TIME</replaceable> is the same
 
202
            as for <varname>timeout</varname> below.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
      
 
207
      <varlistentry>
184
208
        <term><option>fingerprint<literal> = </literal
185
209
        ><replaceable>HEXSTRING</replaceable></option></term>
186
210
        <listitem>
228
252
            will wait for a checker to complete until the below
229
253
            <quote><varname>timeout</varname></quote> occurs, at which
230
254
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
255
            killed.  The default interval is 2 minutes.
232
256
          </para>
233
257
          <para>
234
258
            The format of <replaceable>TIME</replaceable> is the same
298
322
            This option is <emphasis>optional</emphasis>.
299
323
          </para>
300
324
          <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.
 
325
            The timeout is how long the server will wait, after a
 
326
            successful checker run, until a client is disabled and not
 
327
            allowed to get the data this server holds.  By default
 
328
            Mandos will use 5 minutes.  See also the
 
329
            <option>extended_timeout</option> option.
305
330
          </para>
306
331
          <para>
307
332
            The <replaceable>TIME</replaceable> is specified as a
319
344
        </listitem>
320
345
      </varlistentry>
321
346
      
 
347
      <varlistentry>
 
348
        <term><option>enabled<literal> = </literal>{ <literal
 
349
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
350
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
351
        >no</literal> | <literal>false</literal> | <literal
 
352
        >off</literal> }</option></term>
 
353
        <listitem>
 
354
          <para>
 
355
            Whether this client should be enabled by default.  The
 
356
            default is <quote>true</quote>.
 
357
          </para>
 
358
        </listitem>
 
359
      </varlistentry>
 
360
      
322
361
    </variablelist>
323
362
  </refsect1>
324
363
  
357
396
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
358
397
        ></quote> will be replaced by the value of the attribute
359
398
        <varname>foo</varname> of the internal
360
 
        <quote><classname>Client</classname></quote> object.  See the
361
 
        source code for details, and let the authors know of any
362
 
        attributes that are useful so they may be preserved to any new
363
 
        versions of this software.
 
399
        <quote><classname>Client</classname></quote> object in the
 
400
        Mandos server.  The currently allowed values for
 
401
        <replaceable>foo</replaceable> are:
 
402
        <quote><literal>approval_delay</literal></quote>,
 
403
        <quote><literal>approval_duration</literal></quote>,
 
404
        <quote><literal>created</literal></quote>,
 
405
        <quote><literal>enabled</literal></quote>,
 
406
        <quote><literal>fingerprint</literal></quote>,
 
407
        <quote><literal>host</literal></quote>,
 
408
        <quote><literal>interval</literal></quote>,
 
409
        <quote><literal>last_approval_request</literal></quote>,
 
410
        <quote><literal>last_checked_ok</literal></quote>,
 
411
        <quote><literal>last_enabled</literal></quote>,
 
412
        <quote><literal>name</literal></quote>,
 
413
        <quote><literal>timeout</literal></quote>, and, if using
 
414
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
415
        See the source code for details.  <emphasis role="strong"
 
416
        >Currently, <emphasis>none</emphasis> of these attributes
 
417
        except <quote><literal>host</literal></quote> are guaranteed
 
418
        to be valid in future versions.</emphasis> Therefore, please
 
419
        let the authors know of any attributes that are useful so they
 
420
        may be preserved to any new versions of this software.
364
421
      </para>
365
422
      <para>
366
423
        Note that this means that, in order to include an actual
401
458
    <informalexample>
402
459
      <programlisting>
403
460
[DEFAULT]
404
 
timeout = 1h
405
 
interval = 5m
 
461
timeout = 5m
 
462
interval = 2m
406
463
checker = fping -q -- %%(host)s
407
464
 
408
465
# Client "foo"
441
498
  <refsect1 id="see_also">
442
499
    <title>SEE ALSO</title>
443
500
    <para>
 
501
      <citerefentry><refentrytitle>intro</refentrytitle>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>,
444
503
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
445
504
      <manvolnum>8</manvolnum></citerefentry>,
446
505
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>