/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-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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