/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

Updated year in copyright notices.

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 "2016-02-28">
 
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
40
      <holder>Teddy Hogeborn</holder>
45
41
      <holder>Björn Påhlsson</holder>
46
42
    </copyright>
70
66
      ><refentrytitle>mandos</refentrytitle>
71
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
68
      The file needs to list all clients that should be able to use
73
 
      the service.  The settings in this file can be overridden by
74
 
      runtime changes to the server, which it saves across restarts.
75
 
      (See the section called <quote>PERSISTENT STATE</quote> in
76
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
78
 
      >changes</emphasis> to this file (including adding and removing
79
 
      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.
80
71
    </para>
81
72
    <para>
82
73
      The format starts with a <literal>[<replaceable>section
121
112
          <para>
122
113
            How long to wait for external approval before resorting to
123
114
            use the <option>approved_by_default</option> value.  The
124
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
115
            default is <quote>0s</quote>, i.e. not to wait.
125
116
          </para>
126
117
          <para>
127
118
            The format of <replaceable>TIME</replaceable> is the same
171
162
            This option is <emphasis>optional</emphasis>.
172
163
          </para>
173
164
          <para>
174
 
            This option overrides the default shell command that the
175
 
            server will use to check if the client is still up.  Any
176
 
            output of the command will be ignored, only the exit code
177
 
            is checked:  If the exit code of the command is zero, the
178
 
            client is considered up.  The command will be run using
179
 
            <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>
180
171
            <option>-c</option></command></quote>, so
181
172
            <varname>PATH</varname> will be searched.  The default
182
173
            value for the checker command is <quote><literal
183
174
            ><command>fping</command> <option>-q</option> <option
184
 
            >--</option> %%(host)s</literal></quote>.  Note that
185
 
            <command>mandos-keygen</command>, when generating output
186
 
            to be inserted into this file, normally looks for an SSH
187
 
            server on the Mandos client, and, if it find one, outputs
188
 
            a <option>checker</option> option to check for the
189
 
            client’s key fingerprint – this is more secure against
190
 
            spoofing.
 
175
            >--</option> %%(host)s</literal></quote>.
191
176
          </para>
192
177
          <para>
193
178
            In addition to normal start time expansion, this option
345
330
            <option>extended_timeout</option> option.
346
331
          </para>
347
332
          <para>
348
 
            The <replaceable>TIME</replaceable> is specified as an RFC
349
 
            3339 duration; for example
350
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
 
            one year, two months, three days, four hours, five
352
 
            minutes, and six seconds.  Some values can be omitted, see
353
 
            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.
354
344
          </para>
355
345
        </listitem>
356
346
      </varlistentry>
414
404
        <quote><literal>approval_duration</literal></quote>,
415
405
        <quote><literal>created</literal></quote>,
416
406
        <quote><literal>enabled</literal></quote>,
417
 
        <quote><literal>expires</literal></quote>,
418
407
        <quote><literal>fingerprint</literal></quote>,
419
408
        <quote><literal>host</literal></quote>,
420
409
        <quote><literal>interval</literal></quote>,
470
459
    <informalexample>
471
460
      <programlisting>
472
461
[DEFAULT]
473
 
timeout = PT5M
474
 
interval = PT2M
 
462
timeout = 5m
 
463
interval = 2m
475
464
checker = fping -q -- %%(host)s
476
465
 
477
466
# Client "foo"
494
483
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
495
484
        QlnHIvPzEArRQLo=
496
485
host = foo.example.org
497
 
interval = PT1M
 
486
interval = 1m
498
487
 
499
488
# Client "bar"
500
489
[bar]
501
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
502
491
secfile = /etc/mandos/bar-secret
503
 
timeout = PT15M
 
492
timeout = 15m
504
493
approved_by_default = False
505
 
approval_delay = PT30S
 
494
approval_delay = 30s
506
495
      </programlisting>
507
496
    </informalexample>
508
497
  </refsect1>
517
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
518
507
      <manvolnum>5</manvolnum></citerefentry>,
519
508
      <citerefentry><refentrytitle>mandos</refentrytitle>
520
 
      <manvolnum>8</manvolnum></citerefentry>,
521
 
      <citerefentry><refentrytitle>fping</refentrytitle>
522
509
      <manvolnum>8</manvolnum></citerefentry>
523
510
    </para>
524
 
    <variablelist>
525
 
      <varlistentry>
526
 
        <term>
527
 
          RFC 3339: <citetitle>Date and Time on the Internet:
528
 
          Timestamps</citetitle>
529
 
        </term>
530
 
      <listitem>
531
 
        <para>
532
 
          The time intervals are in the "duration" format, as
533
 
          specified in ABNF in Appendix A of RFC 3339.
534
 
        </para>
535
 
      </listitem>
536
 
      </varlistentry>
537
 
    </variablelist>
538
511
  </refsect1>
539
512
</refentry>
540
513
<!-- Local Variables: -->