/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

* .bzrignore (statedir): Added.

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 "2015-07-20">
 
6
<!ENTITY TIMESTAMP "2012-05-12">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
39
39
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
40
      <holder>Teddy Hogeborn</holder>
44
41
      <holder>Björn Påhlsson</holder>
45
42
    </copyright>
120
117
          <para>
121
118
            How long to wait for external approval before resorting to
122
119
            use the <option>approved_by_default</option> value.  The
123
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
120
            default is <quote>0s</quote>, i.e. not to wait.
124
121
          </para>
125
122
          <para>
126
123
            The format of <replaceable>TIME</replaceable> is the same
170
167
            This option is <emphasis>optional</emphasis>.
171
168
          </para>
172
169
          <para>
173
 
            This option overrides the default shell command that the
174
 
            server will use to check if the client is still up.  Any
175
 
            output of the command will be ignored, only the exit code
176
 
            is checked:  If the exit code of the command is zero, the
177
 
            client is considered up.  The command will be run using
178
 
            <quote><command><filename>/bin/sh</filename>
 
170
            This option allows you to override the default shell
 
171
            command that the server will use to check if the client is
 
172
            still up.  Any output of the command will be ignored, only
 
173
            the exit code is checked:  If the exit code of the command
 
174
            is zero, the client is considered up.  The command will be
 
175
            run using <quote><command><filename>/bin/sh</filename>
179
176
            <option>-c</option></command></quote>, so
180
177
            <varname>PATH</varname> will be searched.  The default
181
178
            value for the checker command is <quote><literal
182
179
            ><command>fping</command> <option>-q</option> <option
183
 
            >--</option> %%(host)s</literal></quote>.  Note that
184
 
            <command>mandos-keygen</command>, when generating output
185
 
            to be inserted into this file, normally looks for an SSH
186
 
            server on the Mandos client, and, if it find one, outputs
187
 
            a <option>checker</option> option to check for the
188
 
            client’s key fingerprint – this is more secure against
189
 
            spoofing.
 
180
            >--</option> %%(host)s</literal></quote>.
190
181
          </para>
191
182
          <para>
192
183
            In addition to normal start time expansion, this option
344
335
            <option>extended_timeout</option> option.
345
336
          </para>
346
337
          <para>
347
 
            The <replaceable>TIME</replaceable> is specified as an RFC
348
 
            3339 duration; for example
349
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
 
            one year, two months, three days, four hours, five
351
 
            minutes, and six seconds.  Some values can be omitted, see
352
 
            RFC 3339 Appendix A for details.
 
338
            The <replaceable>TIME</replaceable> is specified as a
 
339
            space-separated number of values, each of which is a
 
340
            number and a one-character suffix.  The suffix must be one
 
341
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
342
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
343
            minutes, hours, and weeks, respectively.  The values are
 
344
            added together to give the total time value, so all of
 
345
            <quote><literal>330s</literal></quote>,
 
346
            <quote><literal>110s 110s 110s</literal></quote>, and
 
347
            <quote><literal>5m 30s</literal></quote> will give a value
 
348
            of five minutes and thirty seconds.
353
349
          </para>
354
350
        </listitem>
355
351
      </varlistentry>
469
465
    <informalexample>
470
466
      <programlisting>
471
467
[DEFAULT]
472
 
timeout = PT5M
473
 
interval = PT2M
 
468
timeout = 5m
 
469
interval = 2m
474
470
checker = fping -q -- %%(host)s
475
471
 
476
472
# Client "foo"
493
489
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
494
490
        QlnHIvPzEArRQLo=
495
491
host = foo.example.org
496
 
interval = PT1M
 
492
interval = 1m
497
493
 
498
494
# Client "bar"
499
495
[bar]
500
496
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
501
497
secfile = /etc/mandos/bar-secret
502
 
timeout = PT15M
 
498
timeout = 15m
503
499
approved_by_default = False
504
 
approval_delay = PT30S
 
500
approval_delay = 30s
505
501
      </programlisting>
506
502
    </informalexample>
507
503
  </refsect1>
516
512
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
517
513
      <manvolnum>5</manvolnum></citerefentry>,
518
514
      <citerefentry><refentrytitle>mandos</refentrytitle>
519
 
      <manvolnum>8</manvolnum></citerefentry>,
520
 
      <citerefentry><refentrytitle>fping</refentrytitle>
521
515
      <manvolnum>8</manvolnum></citerefentry>
522
516
    </para>
523
 
    <variablelist>
524
 
      <varlistentry>
525
 
        <term>
526
 
          RFC 3339: <citetitle>Date and Time on the Internet:
527
 
          Timestamps</citetitle>
528
 
        </term>
529
 
      <listitem>
530
 
        <para>
531
 
          The time intervals are in the "duration" format, as
532
 
          specified in ABNF in Appendix A of RFC 3339.
533
 
        </para>
534
 
      </listitem>
535
 
      </varlistentry>
536
 
    </variablelist>
537
517
  </refsect1>
538
518
</refentry>
539
519
<!-- Local Variables: -->