/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: 2017-08-20 16:23:14 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820162314-hcvb6auvbm0mlppk
Use the https form of the Format URL in debian/copyright.

* debian/copyright (Format): Use https in URL.

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