/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-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:50:20 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • 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-keygen.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
127
127
      </group>
128
128
      <sbr/>
129
129
      <group>
 
130
        <arg choice="plain"><option>--tls-keytype
 
131
        <replaceable>KEYTYPE</replaceable></option></arg>
 
132
        <arg choice="plain"><option>-T
 
133
        <replaceable>KEYTYPE</replaceable></option></arg>
 
134
      </group>
 
135
      <sbr/>
 
136
      <group>
130
137
        <arg choice="plain"><option>--force</option></arg>
131
138
        <arg choice="plain"><option>-f</option></arg>
132
139
      </group>
180
187
    <title>DESCRIPTION</title>
181
188
    <para>
182
189
      <command>&COMMANDNAME;</command> is a program to generate the
183
 
      OpenPGP key used by
 
190
      TLS and OpenPGP keys used by
184
191
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
 
      normally written to /etc/mandos for later installation into the
187
 
      initrd image, but this, and most other things, can be changed
188
 
      with command line options.
 
192
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
 
193
      normally written to /etc/keys/mandos for later installation into
 
194
      the initrd image, but this, and most other things, can be
 
195
      changed with command line options.
189
196
    </para>
190
197
    <para>
191
198
      This program can also be used with the
228
235
        <replaceable>DIRECTORY</replaceable></option></term>
229
236
        <listitem>
230
237
          <para>
231
 
            Target directory for key files.  Default is
232
 
            <filename class="directory">/etc/mandos</filename>.
 
238
            Target directory for key files.  Default is <filename
 
239
            class="directory">/etc/keys/mandos</filename>.
233
240
          </para>
234
241
        </listitem>
235
242
      </varlistentry>
241
248
        <replaceable>TYPE</replaceable></option></term>
242
249
        <listitem>
243
250
          <para>
244
 
            Key type.  Default is <quote>RSA</quote>.
 
251
            OpenPGP key type.  Default is <quote>RSA</quote>.
245
252
          </para>
246
253
        </listitem>
247
254
      </varlistentry>
253
260
        <replaceable>BITS</replaceable></option></term>
254
261
        <listitem>
255
262
          <para>
256
 
            Key length in bits.  Default is 4096.
 
263
            OpenPGP key length in bits.  Default is 4096.
257
264
          </para>
258
265
        </listitem>
259
266
      </varlistentry>
265
272
        <replaceable>KEYTYPE</replaceable></option></term>
266
273
        <listitem>
267
274
          <para>
268
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
269
 
            encryption-only).
 
275
            OpenPGP subkey type.  Default is <quote>RSA</quote>
270
276
          </para>
271
277
        </listitem>
272
278
      </varlistentry>
278
284
        <replaceable>BITS</replaceable></option></term>
279
285
        <listitem>
280
286
          <para>
281
 
            Subkey length in bits.  Default is 4096.
 
287
            OpenPGP subkey length in bits.  Default is 4096.
282
288
          </para>
283
289
        </listitem>
284
290
      </varlistentry>
322
328
      </varlistentry>
323
329
      
324
330
      <varlistentry>
 
331
        <term><option>--tls-keytype
 
332
        <replaceable>KEYTYPE</replaceable></option></term>
 
333
        <term><option>-T
 
334
        <replaceable>KEYTYPE</replaceable></option></term>
 
335
        <listitem>
 
336
          <para>
 
337
            TLS key type.  Default is <quote>ed25519</quote>
 
338
          </para>
 
339
        </listitem>
 
340
      </varlistentry>
 
341
      
 
342
      <varlistentry>
325
343
        <term><option>--force</option></term>
326
344
        <term><option>-f</option></term>
327
345
        <listitem>
336
354
        <listitem>
337
355
          <para>
338
356
            Prompt for a password and encrypt it with the key already
339
 
            present in either <filename>/etc/mandos</filename> or the
340
 
            directory specified with the <option>--dir</option>
 
357
            present in either <filename>/etc/keys/mandos</filename> or
 
358
            the directory specified with the <option>--dir</option>
341
359
            option.  Outputs, on standard output, a section suitable
342
360
            for inclusion in <citerefentry><refentrytitle
343
361
            >mandos-clients.conf</refentrytitle><manvolnum
383
401
    <title>OVERVIEW</title>
384
402
    <xi:include href="overview.xml"/>
385
403
    <para>
386
 
      This program is a small utility to generate new OpenPGP keys for
387
 
      new Mandos clients, and to generate sections for inclusion in
388
 
      <filename>clients.conf</filename> on the server.
 
404
      This program is a small utility to generate new TLS and OpenPGP
 
405
      keys for new Mandos clients, and to generate sections for
 
406
      inclusion in <filename>clients.conf</filename> on the server.
389
407
    </para>
390
408
  </refsect1>
391
409
  
423
441
    </para>
424
442
    <variablelist>
425
443
      <varlistentry>
426
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
444
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
427
445
        <listitem>
428
446
          <para>
429
447
            OpenPGP secret key file which will be created or
432
450
        </listitem>
433
451
      </varlistentry>
434
452
      <varlistentry>
435
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
453
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
436
454
        <listitem>
437
455
          <para>
438
456
            OpenPGP public key file which will be created or
441
459
        </listitem>
442
460
      </varlistentry>
443
461
      <varlistentry>
 
462
        <term><filename>/etc/keys/mandos/tls-privkey.pem</filename></term>
 
463
        <listitem>
 
464
          <para>
 
465
            Private key file which will be created or overwritten.
 
466
          </para>
 
467
        </listitem>
 
468
      </varlistentry>
 
469
      <varlistentry>
 
470
        <term><filename>/etc/keys/mandos/tls-pubkey.pem</filename></term>
 
471
        <listitem>
 
472
          <para>
 
473
            Public key file which will be created or overwritten.
 
474
          </para>
 
475
        </listitem>
 
476
      </varlistentry>
 
477
      <varlistentry>
444
478
        <term><filename class="directory">/tmp</filename></term>
445
479
        <listitem>
446
480
          <para>
481
515
    </informalexample>
482
516
    <informalexample>
483
517
      <para>
484
 
        Prompt for a password, encrypt it with the key in <filename
485
 
        class="directory">/etc/mandos</filename> and output a section
486
 
        suitable for <filename>clients.conf</filename>.
 
518
        Prompt for a password, encrypt it with the keys in <filename
 
519
        class="directory">/etc/keys/mandos</filename> and output a
 
520
        section suitable for <filename>clients.conf</filename>.
487
521
      </para>
488
522
      <para>
489
523
        <userinput>&COMMANDNAME; --password</userinput>
491
525
    </informalexample>
492
526
    <informalexample>
493
527
      <para>
494
 
        Prompt for a password, encrypt it with the key in the
 
528
        Prompt for a password, encrypt it with the keys in the
495
529
        <filename>client-key</filename> directory and output a section
496
530
        suitable for <filename>clients.conf</filename>.
497
531
      </para>