/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: 2019-07-25 21:42:40 UTC
  • Revision ID: teddy@recompile.se-20190725214240-31i9qehf60xb8yu4
Use hexadecimal unicode character references, not decimal

* mandos-options.xml (priority): Use "​" instead of "​"
  to make it slightly more clear that ZERO WIDTH SPACE is intended.

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 "2012-05-27">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
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
      <year>2019</year>
40
47
      <holder>Teddy Hogeborn</holder>
41
48
      <holder>Björn Påhlsson</holder>
42
49
    </copyright>
117
124
          <para>
118
125
            How long to wait for external approval before resorting to
119
126
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
121
128
          </para>
122
129
          <para>
123
130
            The format of <replaceable>TIME</replaceable> is the same
177
184
            <varname>PATH</varname> will be searched.  The default
178
185
            value for the checker command is <quote><literal
179
186
            ><command>fping</command> <option>-q</option> <option
180
 
            >--</option> %%(host)s</literal></quote>.
 
187
            >--</option> %%(host)s</literal></quote>.  Note that
 
188
            <command>mandos-keygen</command>, when generating output
 
189
            to be inserted into this file, normally looks for an SSH
 
190
            server on the Mandos client, and, if it finds one, outputs
 
191
            a <option>checker</option> option to check for the
 
192
            client’s SSH key fingerprint – this is more secure against
 
193
            spoofing.
181
194
          </para>
182
195
          <para>
183
196
            In addition to normal start time expansion, this option
220
233
          <para>
221
234
            This option sets the OpenPGP fingerprint that identifies
222
235
            the public key that clients authenticate themselves with
223
 
            through TLS.  The string needs to be in hexidecimal form,
 
236
            through TLS.  The string needs to be in hexadecimal form,
 
237
            but spaces or upper/lower case are not significant.
 
238
          </para>
 
239
        </listitem>
 
240
      </varlistentry>
 
241
      
 
242
      <varlistentry>
 
243
        <term><option>key_id<literal> = </literal
 
244
        ><replaceable>HEXSTRING</replaceable></option></term>
 
245
        <listitem>
 
246
          <para>
 
247
            This option is <emphasis>optional</emphasis>.
 
248
          </para>
 
249
          <para>
 
250
            This option sets the certificate key ID that identifies
 
251
            the public key that clients authenticate themselves with
 
252
            through TLS.  The string needs to be in hexadecimal form,
224
253
            but spaces or upper/lower case are not significant.
225
254
          </para>
226
255
        </listitem>
302
331
          <para>
303
332
            If present, this option must be set to a string of
304
333
            base64-encoded binary data.  It will be decoded and sent
305
 
            to the client matching the above
306
 
            <option>fingerprint</option>.  This should, of course, be
307
 
            OpenPGP encrypted data, decryptable only by the client.
 
334
            to the client matching the above <option>key_id</option>
 
335
            or <option>fingerprint</option>.  This should, of course,
 
336
            be OpenPGP encrypted data, decryptable only by the client.
308
337
            The program <citerefentry><refentrytitle><command
309
338
            >mandos-keygen</command></refentrytitle><manvolnum
310
339
            >8</manvolnum></citerefentry> can, using its
335
364
            <option>extended_timeout</option> option.
336
365
          </para>
337
366
          <para>
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.
 
367
            The <replaceable>TIME</replaceable> is specified as an RFC
 
368
            3339 duration; for example
 
369
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
370
            one year, two months, three days, four hours, five
 
371
            minutes, and six seconds.  Some values can be omitted, see
 
372
            RFC 3339 Appendix A for details.
349
373
          </para>
350
374
        </listitem>
351
375
      </varlistentry>
410
434
        <quote><literal>created</literal></quote>,
411
435
        <quote><literal>enabled</literal></quote>,
412
436
        <quote><literal>expires</literal></quote>,
 
437
        <quote><literal>key_id</literal></quote>,
413
438
        <quote><literal>fingerprint</literal></quote>,
414
439
        <quote><literal>host</literal></quote>,
415
440
        <quote><literal>interval</literal></quote>,
458
483
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
459
484
      obscure.
460
485
    </para>
 
486
    <xi:include href="bugs.xml"/>
461
487
  </refsect1>
462
488
  
463
489
  <refsect1 id="example">
465
491
    <informalexample>
466
492
      <programlisting>
467
493
[DEFAULT]
468
 
timeout = 5m
469
 
interval = 2m
 
494
timeout = PT5M
 
495
interval = PT2M
470
496
checker = fping -q -- %%(host)s
471
497
 
472
498
# Client "foo"
473
499
[foo]
 
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
474
501
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
475
502
secret =
476
503
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
489
516
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
490
517
        QlnHIvPzEArRQLo=
491
518
host = foo.example.org
492
 
interval = 1m
 
519
interval = PT1M
493
520
 
494
521
# Client "bar"
495
522
[bar]
 
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
496
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
497
525
secfile = /etc/mandos/bar-secret
498
 
timeout = 15m
 
526
timeout = PT15M
499
527
approved_by_default = False
500
 
approval_delay = 30s
 
528
approval_delay = PT30S
501
529
      </programlisting>
502
530
    </informalexample>
503
531
  </refsect1>
516
544
      <citerefentry><refentrytitle>fping</refentrytitle>
517
545
      <manvolnum>8</manvolnum></citerefentry>
518
546
    </para>
 
547
    <variablelist>
 
548
      <varlistentry>
 
549
        <term>
 
550
          RFC 3339: <citetitle>Date and Time on the Internet:
 
551
          Timestamps</citetitle>
 
552
        </term>
 
553
      <listitem>
 
554
        <para>
 
555
          The time intervals are in the "duration" format, as
 
556
          specified in ABNF in Appendix A of RFC 3339.
 
557
        </para>
 
558
      </listitem>
 
559
      </varlistentry>
 
560
    </variablelist>
519
561
  </refsect1>
520
562
</refentry>
521
563
<!-- Local Variables: -->