/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: 2015-10-24 18:33:55 UTC
  • mfrom: (328 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 329.
  • Revision ID: teddy@recompile.se-20151024183355-czoyd2jv7u4ijpss
Merge from release branch.

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-02-10">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
39
39
      <year>2013</year>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
42
      <holder>Teddy Hogeborn</holder>
46
43
      <holder>Björn Påhlsson</holder>
47
44
    </copyright>
127
124
      </group>
128
125
      <sbr/>
129
126
      <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>
137
127
        <arg choice="plain"><option>--force</option></arg>
138
128
        <arg choice="plain"><option>-f</option></arg>
139
129
      </group>
187
177
    <title>DESCRIPTION</title>
188
178
    <para>
189
179
      <command>&COMMANDNAME;</command> is a program to generate the
190
 
      TLS and OpenPGP keys used by
 
180
      OpenPGP key used by
191
181
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
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.
 
182
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
183
      normally written to /etc/mandos for later installation into the
 
184
      initrd image, but this, and most other things, can be changed
 
185
      with command line options.
196
186
    </para>
197
187
    <para>
198
188
      This program can also be used with the
235
225
        <replaceable>DIRECTORY</replaceable></option></term>
236
226
        <listitem>
237
227
          <para>
238
 
            Target directory for key files.  Default is <filename
239
 
            class="directory">/etc/keys/mandos</filename>.
 
228
            Target directory for key files.  Default is
 
229
            <filename class="directory">/etc/mandos</filename>.
240
230
          </para>
241
231
        </listitem>
242
232
      </varlistentry>
248
238
        <replaceable>TYPE</replaceable></option></term>
249
239
        <listitem>
250
240
          <para>
251
 
            OpenPGP key type.  Default is <quote>RSA</quote>.
 
241
            Key type.  Default is <quote>RSA</quote>.
252
242
          </para>
253
243
        </listitem>
254
244
      </varlistentry>
260
250
        <replaceable>BITS</replaceable></option></term>
261
251
        <listitem>
262
252
          <para>
263
 
            OpenPGP key length in bits.  Default is 4096.
 
253
            Key length in bits.  Default is 4096.
264
254
          </para>
265
255
        </listitem>
266
256
      </varlistentry>
272
262
        <replaceable>KEYTYPE</replaceable></option></term>
273
263
        <listitem>
274
264
          <para>
275
 
            OpenPGP subkey type.  Default is <quote>RSA</quote>
 
265
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
266
            encryption-only).
276
267
          </para>
277
268
        </listitem>
278
269
      </varlistentry>
284
275
        <replaceable>BITS</replaceable></option></term>
285
276
        <listitem>
286
277
          <para>
287
 
            OpenPGP subkey length in bits.  Default is 4096.
 
278
            Subkey length in bits.  Default is 4096.
288
279
          </para>
289
280
        </listitem>
290
281
      </varlistentry>
328
319
      </varlistentry>
329
320
      
330
321
      <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>
343
322
        <term><option>--force</option></term>
344
323
        <term><option>-f</option></term>
345
324
        <listitem>
354
333
        <listitem>
355
334
          <para>
356
335
            Prompt for a password and encrypt it with the key already
357
 
            present in either <filename>/etc/keys/mandos</filename> or
358
 
            the directory specified with the <option>--dir</option>
 
336
            present in either <filename>/etc/mandos</filename> or the
 
337
            directory specified with the <option>--dir</option>
359
338
            option.  Outputs, on standard output, a section suitable
360
339
            for inclusion in <citerefentry><refentrytitle
361
340
            >mandos-clients.conf</refentrytitle><manvolnum
401
380
    <title>OVERVIEW</title>
402
381
    <xi:include href="overview.xml"/>
403
382
    <para>
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.
 
383
      This program is a small utility to generate new OpenPGP keys for
 
384
      new Mandos clients, and to generate sections for inclusion in
 
385
      <filename>clients.conf</filename> on the server.
407
386
    </para>
408
387
  </refsect1>
409
388
  
441
420
    </para>
442
421
    <variablelist>
443
422
      <varlistentry>
444
 
        <term><filename>/etc/keys/mandos/seckey.txt</filename></term>
 
423
        <term><filename>/etc/mandos/seckey.txt</filename></term>
445
424
        <listitem>
446
425
          <para>
447
426
            OpenPGP secret key file which will be created or
450
429
        </listitem>
451
430
      </varlistentry>
452
431
      <varlistentry>
453
 
        <term><filename>/etc/keys/mandos/pubkey.txt</filename></term>
 
432
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
454
433
        <listitem>
455
434
          <para>
456
435
            OpenPGP public key file which will be created or
459
438
        </listitem>
460
439
      </varlistentry>
461
440
      <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>
478
441
        <term><filename class="directory">/tmp</filename></term>
479
442
        <listitem>
480
443
          <para>
486
449
    </variablelist>
487
450
  </refsect1>
488
451
  
489
 
  <refsect1 id="bugs">
490
 
    <title>BUGS</title>
491
 
    <xi:include href="bugs.xml"/>
492
 
  </refsect1>
 
452
<!--   <refsect1 id="bugs"> -->
 
453
<!--     <title>BUGS</title> -->
 
454
<!--     <para> -->
 
455
<!--     </para> -->
 
456
<!--   </refsect1> -->
493
457
  
494
458
  <refsect1 id="example">
495
459
    <title>EXAMPLE</title>
515
479
    </informalexample>
516
480
    <informalexample>
517
481
      <para>
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>.
 
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>.
521
485
      </para>
522
486
      <para>
523
487
        <userinput>&COMMANDNAME; --password</userinput>
525
489
    </informalexample>
526
490
    <informalexample>
527
491
      <para>
528
 
        Prompt for a password, encrypt it with the keys in the
 
492
        Prompt for a password, encrypt it with the key in the
529
493
        <filename>client-key</filename> directory and output a section
530
494
        suitable for <filename>clients.conf</filename>.
531
495
      </para>