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