/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: 2021-02-01 19:30:45 UTC
  • mto: This revision was merged to the branch mainline in revision 404.
  • Revision ID: teddy@recompile.se-20210201193045-lpg6aprpc4srem6k
Fix issue with french translation

Initial white space was missing in both msgid and msgstr of the french
translation, leading to checking tools reporing an incomplete
translation.  The string is a raw command line command, and therefore
did not need translation, so this was never a user-visible issue.

* debian/po/fr.po: Add missing whitespace to the id and translation
  for msgid " mandos-keygen -F/dev/null|grep ^key_id".

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 "2016-03-05">
 
5
<!ENTITY TIMESTAMP "2019-07-18">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
125
128
      </group>
126
129
      <sbr/>
127
130
      <group>
 
131
        <arg choice="plain"><option>--tls-keytype
 
132
        <replaceable>KEYTYPE</replaceable></option></arg>
 
133
        <arg choice="plain"><option>-T
 
134
        <replaceable>KEYTYPE</replaceable></option></arg>
 
135
      </group>
 
136
      <sbr/>
 
137
      <group>
128
138
        <arg choice="plain"><option>--force</option></arg>
129
139
        <arg choice="plain"><option>-f</option></arg>
130
140
      </group>
178
188
    <title>DESCRIPTION</title>
179
189
    <para>
180
190
      <command>&COMMANDNAME;</command> is a program to generate the
181
 
      OpenPGP key used by
 
191
      TLS and OpenPGP keys used by
182
192
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
183
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
184
 
      normally written to /etc/mandos for later installation into the
185
 
      initrd image, but this, and most other things, can be changed
186
 
      with command line options.
 
193
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
 
194
      normally written to /etc/keys/mandos for later installation into
 
195
      the initrd image, but this, and most other things, can be
 
196
      changed with command line options.
187
197
    </para>
188
198
    <para>
189
199
      This program can also be used with the
226
236
        <replaceable>DIRECTORY</replaceable></option></term>
227
237
        <listitem>
228
238
          <para>
229
 
            Target directory for key files.  Default is
230
 
            <filename class="directory">/etc/mandos</filename>.
 
239
            Target directory for key files.  Default is <filename
 
240
            class="directory">/etc/keys/mandos</filename>.
231
241
          </para>
232
242
        </listitem>
233
243
      </varlistentry>
239
249
        <replaceable>TYPE</replaceable></option></term>
240
250
        <listitem>
241
251
          <para>
242
 
            Key type.  Default is <quote>RSA</quote>.
 
252
            OpenPGP key type.  Default is <quote>RSA</quote>.
243
253
          </para>
244
254
        </listitem>
245
255
      </varlistentry>
251
261
        <replaceable>BITS</replaceable></option></term>
252
262
        <listitem>
253
263
          <para>
254
 
            Key length in bits.  Default is 4096.
 
264
            OpenPGP key length in bits.  Default is 4096.
255
265
          </para>
256
266
        </listitem>
257
267
      </varlistentry>
263
273
        <replaceable>KEYTYPE</replaceable></option></term>
264
274
        <listitem>
265
275
          <para>
266
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
267
 
            encryption-only).
 
276
            OpenPGP subkey type.  Default is <quote>RSA</quote>
268
277
          </para>
269
278
        </listitem>
270
279
      </varlistentry>
276
285
        <replaceable>BITS</replaceable></option></term>
277
286
        <listitem>
278
287
          <para>
279
 
            Subkey length in bits.  Default is 4096.
 
288
            OpenPGP subkey length in bits.  Default is 4096.
280
289
          </para>
281
290
        </listitem>
282
291
      </varlistentry>
320
329
      </varlistentry>
321
330
      
322
331
      <varlistentry>
 
332
        <term><option>--tls-keytype
 
333
        <replaceable>KEYTYPE</replaceable></option></term>
 
334
        <term><option>-T
 
335
        <replaceable>KEYTYPE</replaceable></option></term>
 
336
        <listitem>
 
337
          <para>
 
338
            TLS key type.  Default is <quote>ed25519</quote>
 
339
          </para>
 
340
        </listitem>
 
341
      </varlistentry>
 
342
      
 
343
      <varlistentry>
323
344
        <term><option>--force</option></term>
324
345
        <term><option>-f</option></term>
325
346
        <listitem>
334
355
        <listitem>
335
356
          <para>
336
357
            Prompt for a password and encrypt it with the key already
337
 
            present in either <filename>/etc/mandos</filename> or the
338
 
            directory specified with the <option>--dir</option>
 
358
            present in either <filename>/etc/keys/mandos</filename> or
 
359
            the directory specified with the <option>--dir</option>
339
360
            option.  Outputs, on standard output, a section suitable
340
361
            for inclusion in <citerefentry><refentrytitle
341
362
            >mandos-clients.conf</refentrytitle><manvolnum
342
363
            >8</manvolnum></citerefentry>.  The host name or the name
343
364
            specified with the <option>--name</option> option is used
344
365
            for the section header.  All other options are ignored,
345
 
            and no key is created.
 
366
            and no key is created.  Note: white space is stripped from
 
367
            the beginning and from the end of the password; See <xref
 
368
            linkend="bugs"/>.
346
369
          </para>
347
370
        </listitem>
348
371
      </varlistentry>
354
377
        <listitem>
355
378
          <para>
356
379
            The same as <option>--password</option>, but read from
357
 
            <replaceable>FILE</replaceable>, not the terminal.
 
380
            <replaceable>FILE</replaceable>, not the terminal, and
 
381
            white space is not stripped from the password in any way.
358
382
          </para>
359
383
        </listitem>
360
384
      </varlistentry>
381
405
    <title>OVERVIEW</title>
382
406
    <xi:include href="overview.xml"/>
383
407
    <para>
384
 
      This program is a small utility to generate new OpenPGP keys for
385
 
      new Mandos clients, and to generate sections for inclusion in
386
 
      <filename>clients.conf</filename> on the server.
 
408
      This program is a small utility to generate new TLS and OpenPGP
 
409
      keys for new Mandos clients, and to generate sections for
 
410
      inclusion in <filename>clients.conf</filename> on the server.
387
411
    </para>
388
412
  </refsect1>
389
413
  
421
445
    </para>
422
446
    <variablelist>
423
447
      <varlistentry>
424
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
448
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
425
449
        <listitem>
426
450
          <para>
427
451
            OpenPGP secret key file which will be created or
430
454
        </listitem>
431
455
      </varlistentry>
432
456
      <varlistentry>
433
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
457
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
434
458
        <listitem>
435
459
          <para>
436
460
            OpenPGP public key file which will be created or
439
463
        </listitem>
440
464
      </varlistentry>
441
465
      <varlistentry>
 
466
        <term><filename>/etc/keys/mandos/tls-privkey.pem</filename></term>
 
467
        <listitem>
 
468
          <para>
 
469
            Private key file which will be created or overwritten.
 
470
          </para>
 
471
        </listitem>
 
472
      </varlistentry>
 
473
      <varlistentry>
 
474
        <term><filename>/etc/keys/mandos/tls-pubkey.pem</filename></term>
 
475
        <listitem>
 
476
          <para>
 
477
            Public key file which will be created or overwritten.
 
478
          </para>
 
479
        </listitem>
 
480
      </varlistentry>
 
481
      <varlistentry>
442
482
        <term><filename class="directory">/tmp</filename></term>
443
483
        <listitem>
444
484
          <para>
452
492
  
453
493
  <refsect1 id="bugs">
454
494
    <title>BUGS</title>
 
495
    <para>
 
496
      The <option>--password</option>/<option>-p</option> option
 
497
      strips white space from the start and from the end of the
 
498
      password before using it.  If this is a problem, use the
 
499
      <option>--passfile</option> option instead, which does not do
 
500
      this.
 
501
    </para>
455
502
    <xi:include href="bugs.xml"/>
456
503
  </refsect1>
457
504
  
479
526
    </informalexample>
480
527
    <informalexample>
481
528
      <para>
482
 
        Prompt for a password, encrypt it with the key in <filename
483
 
        class="directory">/etc/mandos</filename> and output a section
484
 
        suitable for <filename>clients.conf</filename>.
 
529
        Prompt for a password, encrypt it with the keys in <filename
 
530
        class="directory">/etc/keys/mandos</filename> and output a
 
531
        section suitable for <filename>clients.conf</filename>.
485
532
      </para>
486
533
      <para>
487
534
        <userinput>&COMMANDNAME; --password</userinput>
489
536
    </informalexample>
490
537
    <informalexample>
491
538
      <para>
492
 
        Prompt for a password, encrypt it with the key in the
 
539
        Prompt for a password, encrypt it with the keys in the
493
540
        <filename>client-key</filename> directory and output a section
494
541
        suitable for <filename>clients.conf</filename>.
495
542
      </para>