/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: 2014-03-10 10:11:37 UTC
  • Revision ID: teddy@recompile.se-20140310101137-3khoc3qrntp13l08
White space fix: change "if (" to "if(" in C code.

* plugins.d/mandos-client.c (start_mandos_communication): White space
                                                          fix.
  (avahi_loop_with_timeout, main): - '' -

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-10-10">
 
6
<!ENTITY TIMESTAMP "2013-10-15">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
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
111
117
          <para>
112
118
            How long to wait for external approval before resorting to
113
119
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
120
            default is <quote>PT0S</quote>, i.e. not to wait.
115
121
          </para>
116
122
          <para>
117
123
            The format of <replaceable>TIME</replaceable> is the same
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
329
335
            <option>extended_timeout</option> option.
330
336
          </para>
331
337
          <para>
332
 
            The <replaceable>TIME</replaceable> is specified as a
333
 
            space-separated number of values, each of which is a
334
 
            number and a one-character suffix.  The suffix must be one
335
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
 
            minutes, hours, and weeks, respectively.  The values are
338
 
            added together to give the total time value, so all of
339
 
            <quote><literal>330s</literal></quote>,
340
 
            <quote><literal>110s 110s 110s</literal></quote>, and
341
 
            <quote><literal>5m 30s</literal></quote> will give a value
342
 
            of five minutes and thirty seconds.
 
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>.
343
358
          </para>
344
359
        </listitem>
345
360
      </varlistentry>
389
404
        <quote><literal>approval_duration</literal></quote>,
390
405
        <quote><literal>created</literal></quote>,
391
406
        <quote><literal>enabled</literal></quote>,
 
407
        <quote><literal>expires</literal></quote>,
392
408
        <quote><literal>fingerprint</literal></quote>,
393
409
        <quote><literal>host</literal></quote>,
394
410
        <quote><literal>interval</literal></quote>,
444
460
    <informalexample>
445
461
      <programlisting>
446
462
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
463
timeout = PT5M
 
464
interval = PT2M
449
465
checker = fping -q -- %%(host)s
450
466
 
451
467
# Client "foo"
468
484
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
485
        QlnHIvPzEArRQLo=
470
486
host = foo.example.org
471
 
interval = 1m
 
487
interval = PT1M
472
488
 
473
489
# Client "bar"
474
490
[bar]
475
491
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
476
492
secfile = /etc/mandos/bar-secret
477
 
timeout = 15m
 
493
timeout = PT15M
478
494
approved_by_default = False
479
 
approval_delay = 30s
 
495
approval_delay = PT30S
480
496
      </programlisting>
481
497
    </informalexample>
482
498
  </refsect1>
491
507
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
508
      <manvolnum>5</manvolnum></citerefentry>,
493
509
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
510
      <manvolnum>8</manvolnum></citerefentry>,
 
511
      <citerefentry><refentrytitle>fping</refentrytitle>
494
512
      <manvolnum>8</manvolnum></citerefentry>
495
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>
496
528
  </refsect1>
497
529
</refentry>
498
530
<!-- Local Variables: -->