/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: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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 "2017-02-23">
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>
40
45
      <holder>Teddy Hogeborn</holder>
41
46
      <holder>Björn Påhlsson</holder>
42
47
    </copyright>
66
71
      ><refentrytitle>mandos</refentrytitle>
67
72
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
73
      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.
 
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.
71
81
    </para>
72
82
    <para>
73
83
      The format starts with a <literal>[<replaceable>section
112
122
          <para>
113
123
            How long to wait for external approval before resorting to
114
124
            use the <option>approved_by_default</option> value.  The
115
 
            default is <quote>0s</quote>, i.e. not to wait.
 
125
            default is <quote>PT0S</quote>, i.e. not to wait.
116
126
          </para>
117
127
          <para>
118
128
            The format of <replaceable>TIME</replaceable> is the same
162
172
            This option is <emphasis>optional</emphasis>.
163
173
          </para>
164
174
          <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>
 
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>
171
181
            <option>-c</option></command></quote>, so
172
182
            <varname>PATH</varname> will be searched.  The default
173
183
            value for the checker command is <quote><literal
174
184
            ><command>fping</command> <option>-q</option> <option
175
 
            >--</option> %%(host)s</literal></quote>.
 
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.
176
192
          </para>
177
193
          <para>
178
194
            In addition to normal start time expansion, this option
215
231
          <para>
216
232
            This option sets the OpenPGP fingerprint that identifies
217
233
            the public key that clients authenticate themselves with
218
 
            through TLS.  The string needs to be in hexidecimal form,
 
234
            through TLS.  The string needs to be in hexadecimal form,
219
235
            but spaces or upper/lower case are not significant.
220
236
          </para>
221
237
        </listitem>
330
346
            <option>extended_timeout</option> option.
331
347
          </para>
332
348
          <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.
 
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.
344
355
          </para>
345
356
        </listitem>
346
357
      </varlistentry>
404
415
        <quote><literal>approval_duration</literal></quote>,
405
416
        <quote><literal>created</literal></quote>,
406
417
        <quote><literal>enabled</literal></quote>,
 
418
        <quote><literal>expires</literal></quote>,
407
419
        <quote><literal>fingerprint</literal></quote>,
408
420
        <quote><literal>host</literal></quote>,
409
421
        <quote><literal>interval</literal></quote>,
452
464
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
453
465
      obscure.
454
466
    </para>
 
467
    <xi:include href="bugs.xml"/>
455
468
  </refsect1>
456
469
  
457
470
  <refsect1 id="example">
459
472
    <informalexample>
460
473
      <programlisting>
461
474
[DEFAULT]
462
 
timeout = 5m
463
 
interval = 2m
 
475
timeout = PT5M
 
476
interval = PT2M
464
477
checker = fping -q -- %%(host)s
465
478
 
466
479
# Client "foo"
483
496
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
484
497
        QlnHIvPzEArRQLo=
485
498
host = foo.example.org
486
 
interval = 1m
 
499
interval = PT1M
487
500
 
488
501
# Client "bar"
489
502
[bar]
490
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
491
504
secfile = /etc/mandos/bar-secret
492
 
timeout = 15m
 
505
timeout = PT15M
493
506
approved_by_default = False
494
 
approval_delay = 30s
 
507
approval_delay = PT30S
495
508
      </programlisting>
496
509
    </informalexample>
497
510
  </refsect1>
506
519
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
507
520
      <manvolnum>5</manvolnum></citerefentry>,
508
521
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
522
      <manvolnum>8</manvolnum></citerefentry>,
 
523
      <citerefentry><refentrytitle>fping</refentrytitle>
509
524
      <manvolnum>8</manvolnum></citerefentry>
510
525
    </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>
511
540
  </refsect1>
512
541
</refentry>
513
542
<!-- Local Variables: -->