/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-10-24 19:34:13 UTC
  • Revision ID: teddy@recompile.se-20121024193413-yiorm0x5lj48fu7i
* mandos: Comment changes.
* mandos-keygen (--password): Fix bashism.  Thanks to Raphael Geissert
                              <atomo64@gmail.com> for the bug report.

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 "2011-09-19">
 
6
<!ENTITY TIMESTAMP "2012-06-23">
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>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
 
39
      <year>2012</year>
39
40
      <holder>Teddy Hogeborn</holder>
40
41
      <holder>Björn Påhlsson</holder>
41
42
    </copyright>
65
66
      ><refentrytitle>mandos</refentrytitle>
66
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
68
      The file needs to list all clients that should be able to use
68
 
      the service.  All clients listed will be regarded as enabled,
69
 
      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.
70
76
    </para>
71
77
    <para>
72
78
      The format starts with a <literal>[<replaceable>section
161
167
            This option is <emphasis>optional</emphasis>.
162
168
          </para>
163
169
          <para>
164
 
            This option allows you to override the default shell
165
 
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            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>
170
176
            <option>-c</option></command></quote>, so
171
177
            <varname>PATH</varname> will be searched.  The default
172
178
            value for the checker command is <quote><literal
190
196
          </para>
191
197
          <para>
192
198
            Extended timeout is an added timeout that is given once
193
 
            after a password has been sent sucessfully to a client.
 
199
            after a password has been sent successfully to a client.
194
200
            The timeout is by default longer than the normal timeout,
195
201
            and is used for handling the extra long downtime while a
196
202
            machine is booting up.  Time to take into consideration
322
328
            This option is <emphasis>optional</emphasis>.
323
329
          </para>
324
330
          <para>
325
 
            The timeout is how long the server will wait (for either a
326
 
            successful checker run or a client receiving its secret)
327
 
            until a client is disabled and not allowed to get the data
328
 
            this server holds.  By default Mandos will use 5 minutes.
329
 
          </para>
330
 
          <para>
331
 
            The <replaceable>TIME</replaceable> is specified as a
332
 
            space-separated number of values, each of which is a
333
 
            number and a one-character suffix.  The suffix must be one
334
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
335
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
336
 
            minutes, hours, and weeks, respectively.  The values are
337
 
            added together to give the total time value, so all of
338
 
            <quote><literal>330s</literal></quote>,
339
 
            <quote><literal>110s 110s 110s</literal></quote>, and
340
 
            <quote><literal>5m 30s</literal></quote> will give a value
341
 
            of five minutes and thirty seconds.
 
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.
 
336
          </para>
 
337
          <para>
 
338
            The <replaceable>TIME</replaceable> is specified as an RFC
 
339
            3339 duration; for example
 
340
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
341
            one year, two months, three days, four hours, five
 
342
            minutes, and six seconds.  Some values can be omitted, see
 
343
            RFC 3339 Appendix A for details.
 
344
          </para>
 
345
        </listitem>
 
346
      </varlistentry>
 
347
      
 
348
      <varlistentry>
 
349
        <term><option>enabled<literal> = </literal>{ <literal
 
350
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
351
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
352
        >no</literal> | <literal>false</literal> | <literal
 
353
        >off</literal> }</option></term>
 
354
        <listitem>
 
355
          <para>
 
356
            Whether this client should be enabled by default.  The
 
357
            default is <quote>true</quote>.
342
358
          </para>
343
359
        </listitem>
344
360
      </varlistentry>
388
404
        <quote><literal>approval_duration</literal></quote>,
389
405
        <quote><literal>created</literal></quote>,
390
406
        <quote><literal>enabled</literal></quote>,
 
407
        <quote><literal>expires</literal></quote>,
391
408
        <quote><literal>fingerprint</literal></quote>,
392
409
        <quote><literal>host</literal></quote>,
393
410
        <quote><literal>interval</literal></quote>,
443
460
    <informalexample>
444
461
      <programlisting>
445
462
[DEFAULT]
446
 
timeout = 5m
447
 
interval = 2m
 
463
timeout = PT5M
 
464
interval = PT2M
448
465
checker = fping -q -- %%(host)s
449
466
 
450
467
# Client "foo"
467
484
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
468
485
        QlnHIvPzEArRQLo=
469
486
host = foo.example.org
470
 
interval = 1m
 
487
interval = PT1M
471
488
 
472
489
# Client "bar"
473
490
[bar]
474
491
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
475
492
secfile = /etc/mandos/bar-secret
476
 
timeout = 15m
 
493
timeout = PT15M
477
494
approved_by_default = False
478
 
approval_delay = 30s
 
495
approval_delay = PT30S
479
496
      </programlisting>
480
497
    </informalexample>
481
498
  </refsect1>
490
507
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
491
508
      <manvolnum>5</manvolnum></citerefentry>,
492
509
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
510
      <manvolnum>8</manvolnum></citerefentry>,
 
511
      <citerefentry><refentrytitle>fping</refentrytitle>
493
512
      <manvolnum>8</manvolnum></citerefentry>
494
513
    </para>
 
514
    <variablelist>
 
515
      <varlistentry>
 
516
        <term>
 
517
          RFC 3339: <citetitle>Date and Time on the Internet:
 
518
          Timestamps</citetitle>
 
519
        </term>
 
520
      <listitem>
 
521
        <para>
 
522
          The time intervals are in the "duration" format, as
 
523
          specified in ABNF in Appendix A of RFC 3339.
 
524
        </para>
 
525
      </listitem>
 
526
      </varlistentry>
 
527
    </variablelist>
495
528
  </refsect1>
496
529
</refentry>
497
530
<!-- Local Variables: -->