/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

  • Committer: Teddy Hogeborn
  • Date: 2015-12-05 01:29:53 UTC
  • Revision ID: teddy@recompile.se-20151205012953-oi5hosp5yqhrmudh
Tags: version-1.7.1-2
* debian/changelog (1.7.1-2): New entry.

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 "2012-01-01">
 
6
<!ENTITY TIMESTAMP "2015-07-20">
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>
40
43
      <holder>Teddy Hogeborn</holder>
41
44
      <holder>Björn Påhlsson</holder>
42
45
    </copyright>
66
69
      ><refentrytitle>mandos</refentrytitle>
67
70
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
71
      The file needs to list all clients that should be able to use
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.
 
72
      the service.  The settings in this file can be overridden by
 
73
      runtime changes to the server, which it saves across restarts.
 
74
      (See the section called <quote>PERSISTENT STATE</quote> in
 
75
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
76
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
77
      >changes</emphasis> to this file (including adding and removing
 
78
      clients) will, at startup, override changes done during runtime.
71
79
    </para>
72
80
    <para>
73
81
      The format starts with a <literal>[<replaceable>section
112
120
          <para>
113
121
            How long to wait for external approval before resorting to
114
122
            use the <option>approved_by_default</option> value.  The
115
 
            default is <quote>0s</quote>, i.e. not to wait.
 
123
            default is <quote>PT0S</quote>, i.e. not to wait.
116
124
          </para>
117
125
          <para>
118
126
            The format of <replaceable>TIME</replaceable> is the same
162
170
            This option is <emphasis>optional</emphasis>.
163
171
          </para>
164
172
          <para>
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>
 
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>
171
179
            <option>-c</option></command></quote>, so
172
180
            <varname>PATH</varname> will be searched.  The default
173
181
            value for the checker command is <quote><literal
174
182
            ><command>fping</command> <option>-q</option> <option
175
 
            >--</option> %%(host)s</literal></quote>.
 
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.
176
190
          </para>
177
191
          <para>
178
192
            In addition to normal start time expansion, this option
330
344
            <option>extended_timeout</option> option.
331
345
          </para>
332
346
          <para>
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.
 
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.
344
353
          </para>
345
354
        </listitem>
346
355
      </varlistentry>
404
413
        <quote><literal>approval_duration</literal></quote>,
405
414
        <quote><literal>created</literal></quote>,
406
415
        <quote><literal>enabled</literal></quote>,
 
416
        <quote><literal>expires</literal></quote>,
407
417
        <quote><literal>fingerprint</literal></quote>,
408
418
        <quote><literal>host</literal></quote>,
409
419
        <quote><literal>interval</literal></quote>,
459
469
    <informalexample>
460
470
      <programlisting>
461
471
[DEFAULT]
462
 
timeout = 5m
463
 
interval = 2m
 
472
timeout = PT5M
 
473
interval = PT2M
464
474
checker = fping -q -- %%(host)s
465
475
 
466
476
# Client "foo"
483
493
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
484
494
        QlnHIvPzEArRQLo=
485
495
host = foo.example.org
486
 
interval = 1m
 
496
interval = PT1M
487
497
 
488
498
# Client "bar"
489
499
[bar]
490
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
491
501
secfile = /etc/mandos/bar-secret
492
 
timeout = 15m
 
502
timeout = PT15M
493
503
approved_by_default = False
494
 
approval_delay = 30s
 
504
approval_delay = PT30S
495
505
      </programlisting>
496
506
    </informalexample>
497
507
  </refsect1>
506
516
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
507
517
      <manvolnum>5</manvolnum></citerefentry>,
508
518
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
519
      <manvolnum>8</manvolnum></citerefentry>,
 
520
      <citerefentry><refentrytitle>fping</refentrytitle>
509
521
      <manvolnum>8</manvolnum></citerefentry>
510
522
    </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>
511
537
  </refsect1>
512
538
</refentry>
513
539
<!-- Local Variables: -->