/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-04-24 06:55:34 UTC
  • Revision ID: teddy@recompile.se-20120424065534-n1jqfth9odw3l1jr
* network-hooks.d/bridge: Move "start" and "stop" commands to separate
                          functions.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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 "2018-02-08">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
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
 
      <year>2016</year>
44
 
      <year>2017</year>
45
 
      <year>2018</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
123
117
          <para>
124
118
            How long to wait for external approval before resorting to
125
119
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
120
            default is <quote>0s</quote>, i.e. not to wait.
127
121
          </para>
128
122
          <para>
129
123
            The format of <replaceable>TIME</replaceable> is the same
173
167
            This option is <emphasis>optional</emphasis>.
174
168
          </para>
175
169
          <para>
176
 
            This option overrides the default shell command that the
177
 
            server will use to check if the client is still up.  Any
178
 
            output of the command will be ignored, only the exit code
179
 
            is checked:  If the exit code of the command is zero, the
180
 
            client is considered up.  The command will be run using
181
 
            <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>
182
176
            <option>-c</option></command></quote>, so
183
177
            <varname>PATH</varname> will be searched.  The default
184
178
            value for the checker command is <quote><literal
185
179
            ><command>fping</command> <option>-q</option> <option
186
 
            >--</option> %%(host)s</literal></quote>.  Note that
187
 
            <command>mandos-keygen</command>, when generating output
188
 
            to be inserted into this file, normally looks for an SSH
189
 
            server on the Mandos client, and, if it find one, outputs
190
 
            a <option>checker</option> option to check for the
191
 
            client’s key fingerprint – this is more secure against
192
 
            spoofing.
 
180
            >--</option> %%(host)s</literal></quote>.
193
181
          </para>
194
182
          <para>
195
183
            In addition to normal start time expansion, this option
232
220
          <para>
233
221
            This option sets the OpenPGP fingerprint that identifies
234
222
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
 
223
            through TLS.  The string needs to be in hexidecimal form,
236
224
            but spaces or upper/lower case are not significant.
237
225
          </para>
238
226
        </listitem>
347
335
            <option>extended_timeout</option> option.
348
336
          </para>
349
337
          <para>
350
 
            The <replaceable>TIME</replaceable> is specified as an RFC
351
 
            3339 duration; for example
352
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
 
            one year, two months, three days, four hours, five
354
 
            minutes, and six seconds.  Some values can be omitted, see
355
 
            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.
356
349
          </para>
357
350
        </listitem>
358
351
      </varlistentry>
416
409
        <quote><literal>approval_duration</literal></quote>,
417
410
        <quote><literal>created</literal></quote>,
418
411
        <quote><literal>enabled</literal></quote>,
419
 
        <quote><literal>expires</literal></quote>,
420
412
        <quote><literal>fingerprint</literal></quote>,
421
413
        <quote><literal>host</literal></quote>,
422
414
        <quote><literal>interval</literal></quote>,
465
457
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
466
458
      obscure.
467
459
    </para>
468
 
    <xi:include href="bugs.xml"/>
469
460
  </refsect1>
470
461
  
471
462
  <refsect1 id="example">
473
464
    <informalexample>
474
465
      <programlisting>
475
466
[DEFAULT]
476
 
timeout = PT5M
477
 
interval = PT2M
 
467
timeout = 5m
 
468
interval = 2m
478
469
checker = fping -q -- %%(host)s
479
470
 
480
471
# Client "foo"
497
488
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
489
        QlnHIvPzEArRQLo=
499
490
host = foo.example.org
500
 
interval = PT1M
 
491
interval = 1m
501
492
 
502
493
# Client "bar"
503
494
[bar]
504
495
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
505
496
secfile = /etc/mandos/bar-secret
506
 
timeout = PT15M
 
497
timeout = 15m
507
498
approved_by_default = False
508
 
approval_delay = PT30S
 
499
approval_delay = 30s
509
500
      </programlisting>
510
501
    </informalexample>
511
502
  </refsect1>
520
511
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
512
      <manvolnum>5</manvolnum></citerefentry>,
522
513
      <citerefentry><refentrytitle>mandos</refentrytitle>
523
 
      <manvolnum>8</manvolnum></citerefentry>,
524
 
      <citerefentry><refentrytitle>fping</refentrytitle>
525
514
      <manvolnum>8</manvolnum></citerefentry>
526
515
    </para>
527
 
    <variablelist>
528
 
      <varlistentry>
529
 
        <term>
530
 
          RFC 3339: <citetitle>Date and Time on the Internet:
531
 
          Timestamps</citetitle>
532
 
        </term>
533
 
      <listitem>
534
 
        <para>
535
 
          The time intervals are in the "duration" format, as
536
 
          specified in ABNF in Appendix A of RFC 3339.
537
 
        </para>
538
 
      </listitem>
539
 
      </varlistentry>
540
 
    </variablelist>
541
516
  </refsect1>
542
517
</refentry>
543
518
<!-- Local Variables: -->