/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-01-01 01:16:15 UTC
  • Revision ID: teddy@recompile.se-20120101011615-1jzyuxbw1z4700a3
* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2013-10-15">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
66
66
      ><refentrytitle>mandos</refentrytitle>
67
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
68
      The file needs to list all clients that should be able to use
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
      the service.  All clients listed will be regarded as enabled,
 
70
      even if a client was disabled in a previous run of the server.
76
71
    </para>
77
72
    <para>
78
73
      The format starts with a <literal>[<replaceable>section
117
112
          <para>
118
113
            How long to wait for external approval before resorting to
119
114
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
115
            default is <quote>0s</quote>, i.e. not to wait.
121
116
          </para>
122
117
          <para>
123
118
            The format of <replaceable>TIME</replaceable> is the same
167
162
            This option is <emphasis>optional</emphasis>.
168
163
          </para>
169
164
          <para>
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>
 
165
            This option allows you to override the default shell
 
166
            command that the server will use to check if the client is
 
167
            still up.  Any output of the command will be ignored, only
 
168
            the exit code is checked:  If the exit code of the command
 
169
            is zero, the client is considered up.  The command will be
 
170
            run using <quote><command><filename>/bin/sh</filename>
176
171
            <option>-c</option></command></quote>, so
177
172
            <varname>PATH</varname> will be searched.  The default
178
173
            value for the checker command is <quote><literal
335
330
            <option>extended_timeout</option> option.
336
331
          </para>
337
332
          <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.
 
333
            The <replaceable>TIME</replaceable> is specified as a
 
334
            space-separated number of values, each of which is a
 
335
            number and a one-character suffix.  The suffix must be one
 
336
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
337
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
338
            minutes, hours, and weeks, respectively.  The values are
 
339
            added together to give the total time value, so all of
 
340
            <quote><literal>330s</literal></quote>,
 
341
            <quote><literal>110s 110s 110s</literal></quote>, and
 
342
            <quote><literal>5m 30s</literal></quote> will give a value
 
343
            of five minutes and thirty seconds.
344
344
          </para>
345
345
        </listitem>
346
346
      </varlistentry>
404
404
        <quote><literal>approval_duration</literal></quote>,
405
405
        <quote><literal>created</literal></quote>,
406
406
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>expires</literal></quote>,
408
407
        <quote><literal>fingerprint</literal></quote>,
409
408
        <quote><literal>host</literal></quote>,
410
409
        <quote><literal>interval</literal></quote>,
460
459
    <informalexample>
461
460
      <programlisting>
462
461
[DEFAULT]
463
 
timeout = PT5M
464
 
interval = PT2M
 
462
timeout = 5m
 
463
interval = 2m
465
464
checker = fping -q -- %%(host)s
466
465
 
467
466
# Client "foo"
484
483
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
484
        QlnHIvPzEArRQLo=
486
485
host = foo.example.org
487
 
interval = PT1M
 
486
interval = 1m
488
487
 
489
488
# Client "bar"
490
489
[bar]
491
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
491
secfile = /etc/mandos/bar-secret
493
 
timeout = PT15M
 
492
timeout = 15m
494
493
approved_by_default = False
495
 
approval_delay = PT30S
 
494
approval_delay = 30s
496
495
      </programlisting>
497
496
    </informalexample>
498
497
  </refsect1>
507
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
507
      <manvolnum>5</manvolnum></citerefentry>,
509
508
      <citerefentry><refentrytitle>mandos</refentrytitle>
510
 
      <manvolnum>8</manvolnum></citerefentry>,
511
 
      <citerefentry><refentrytitle>fping</refentrytitle>
512
509
      <manvolnum>8</manvolnum></citerefentry>
513
510
    </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>
528
511
  </refsect1>
529
512
</refentry>
530
513
<!-- Local Variables: -->