/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-10 03:50:20 UTC
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
http://bugs.debian.org/879538
http://bugs.debian.org/916673
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

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-01-01">
 
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
167
173
            This option is <emphasis>optional</emphasis>.
168
174
          </para>
169
175
          <para>
170
 
            This option allows you to override the default shell
171
 
            command that the server will use to check if the client is
172
 
            still up.  Any output of the command will be ignored, only
173
 
            the exit code is checked:  If the exit code of the command
174
 
            is zero, the client is considered up.  The command will be
175
 
            run using <quote><command><filename>/bin/sh</filename>
 
176
            This option overrides the default shell command that the
 
177
            server will use to check if the client is still up.  Any
 
178
            output of the command will be ignored, only the exit code
 
179
            is checked:  If the exit code of the command is zero, the
 
180
            client is considered up.  The command will be run using
 
181
            <quote><command><filename>/bin/sh</filename>
176
182
            <option>-c</option></command></quote>, so
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 finds one, outputs
 
190
            a <option>checker</option> option to check for the
 
191
            client’s SSH 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>
409
432
        <quote><literal>approval_duration</literal></quote>,
410
433
        <quote><literal>created</literal></quote>,
411
434
        <quote><literal>enabled</literal></quote>,
 
435
        <quote><literal>expires</literal></quote>,
 
436
        <quote><literal>key_id</literal></quote>,
412
437
        <quote><literal>fingerprint</literal></quote>,
413
438
        <quote><literal>host</literal></quote>,
414
439
        <quote><literal>interval</literal></quote>,
457
482
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
458
483
      obscure.
459
484
    </para>
 
485
    <xi:include href="bugs.xml"/>
460
486
  </refsect1>
461
487
  
462
488
  <refsect1 id="example">
464
490
    <informalexample>
465
491
      <programlisting>
466
492
[DEFAULT]
467
 
timeout = 5m
468
 
interval = 2m
 
493
timeout = PT5M
 
494
interval = PT2M
469
495
checker = fping -q -- %%(host)s
470
496
 
471
497
# Client "foo"
472
498
[foo]
 
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
473
500
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
474
501
secret =
475
502
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
488
515
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
489
516
        QlnHIvPzEArRQLo=
490
517
host = foo.example.org
491
 
interval = 1m
 
518
interval = PT1M
492
519
 
493
520
# Client "bar"
494
521
[bar]
 
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
495
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
496
524
secfile = /etc/mandos/bar-secret
497
 
timeout = 15m
 
525
timeout = PT15M
498
526
approved_by_default = False
499
 
approval_delay = 30s
 
527
approval_delay = PT30S
500
528
      </programlisting>
501
529
    </informalexample>
502
530
  </refsect1>
511
539
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
512
540
      <manvolnum>5</manvolnum></citerefentry>,
513
541
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
542
      <manvolnum>8</manvolnum></citerefentry>,
 
543
      <citerefentry><refentrytitle>fping</refentrytitle>
514
544
      <manvolnum>8</manvolnum></citerefentry>
515
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>
516
560
  </refsect1>
517
561
</refentry>
518
562
<!-- Local Variables: -->